Interface StudiosApiGetStudiosRequest

Request parameters for getStudios operation in StudiosApi.

Export

StudiosApiGetStudiosRequest

interface StudiosApiGetStudiosRequest {
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableTotalRecordCount?: boolean;
    enableUserData?: boolean;
    excludeItemTypes?: BaseItemKind[];
    fields?: ItemFields[];
    imageTypeLimit?: number;
    includeItemTypes?: BaseItemKind[];
    isFavorite?: boolean;
    limit?: number;
    nameLessThan?: string;
    nameStartsWith?: string;
    nameStartsWithOrGreater?: string;
    parentId?: string;
    searchTerm?: string;
    startIndex?: number;
    userId?: string;
}

Properties

enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? excludeItemTypes? fields? imageTypeLimit? includeItemTypes? isFavorite? limit? nameLessThan? nameStartsWith? nameStartsWithOrGreater? parentId? searchTerm? startIndex? userId?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional, include image information in output.

Memberof

StudiosApiGetStudios

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

StudiosApiGetStudios

Optional ReadonlyenableTotalRecordCount

enableTotalRecordCount?: boolean

Total record count.

Memberof

StudiosApiGetStudios

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional, include user data.

Memberof

StudiosApiGetStudios

Optional ReadonlyexcludeItemTypes

excludeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.

Memberof

StudiosApiGetStudios

Optional Readonlyfields

fields?: ItemFields[]

Optional. Specify additional fields of information to return in the output.

Memberof

StudiosApiGetStudios

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

Optional, the max number of images to return, per image type.

Memberof

StudiosApiGetStudios

Optional ReadonlyincludeItemTypes

includeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

Memberof

StudiosApiGetStudios

Optional ReadonlyisFavorite

isFavorite?: boolean

Optional filter by items that are marked as favorite, or not.

Memberof

StudiosApiGetStudios

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

StudiosApiGetStudios

Optional ReadonlynameLessThan

nameLessThan?: string

Optional filter by items whose name is equally or lesser than a given input string.

Memberof

StudiosApiGetStudios

Optional ReadonlynameStartsWith

nameStartsWith?: string

Optional filter by items whose name is sorted equally than a given input string.

Memberof

StudiosApiGetStudios

Optional ReadonlynameStartsWithOrGreater

nameStartsWithOrGreater?: string

Optional filter by items whose name is sorted equally or greater than a given input string.

Memberof

StudiosApiGetStudios

Optional ReadonlyparentId

parentId?: string

Specify this to localize the search to a specific item or folder. Omit to use the root.

Memberof

StudiosApiGetStudios

Optional ReadonlysearchTerm

searchTerm?: string

Optional. Search term.

Memberof

StudiosApiGetStudios

Optional ReadonlystartIndex

startIndex?: number

Optional. The record index to start at. All items with a lower index will be dropped from the results.

Memberof

StudiosApiGetStudios

Optional ReadonlyuserId

userId?: string

User id.

Memberof

StudiosApiGetStudios

Settings

Member Visibility

On This Page

Properties