Users.getMultimediaGalleryPrefs (Method)

Returns a structure containing multimedia gallery preferences for the current or default user.

Returns:

Users_GetMultimediaGalleryPrefs_Result (struct)

Each row of the returned query results has the following fields:

Field Name Type Description
autoPreviewOn Boolean Boolean flag which when set to true indicates that thumbnails are automatically previewed.
displayMode MultimediaGalleryDisplayMode String identifying how CommonSpot should display the multimedia gallery; for example, 'List', 'Small Images', 'Large Images', or 'Filmstrip'.

Arguments:

Name Type Required Description
forDefaultUser Boolean Optional. Defaults to '0'. Boolean flag which when set to true tells CommonSpot to return the default settings for users who have not established multimedia gallery preferences. If this is false, CommonSpot returns the current user's settings.

Context:

License Requirements (none)
Permission Requirements (none)
Deny Context (none)
Require Context Authoring
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization Customization is not supported for this method.

Error Codes:

None

Notes:

None