Namespace: sdkV2/sdkV2/users

Source: source/api/sdk.v2.bs, line 19

Methods

(static) DeleteRating(userid, itemid) → {dynamic}

Deletes a user's saved personal rating for an item. V2: DELETE /UserItems/{itemId}/Rating?userId=

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v2.bs, line 218

Returns:

Type:: dynamic

(static) GetGroupingOptions(id) → {dynamic}

Get user view grouping options. V2: GET /UserViews/GroupingOptions

Parameters:

Name	Type	Description
`id`	string

Source: source/api/sdk.v2.bs, line 98

Returns:

Type:: dynamic

(static) GetImageURL(id, imagetypeopt, imageindexopt, paramsopt) → {dynamic}

Get user profile image URL. V2: GET /UserImage?userId=&type=&index=

Parameters:

Name	Type	Attributes	Default
`id`	string
`imagetype`	string	<optional>	"primary"
`imageindex`	integer	<optional>	0
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 37

Returns:

Type:: dynamic

(static) GetIntros(_userid, itemid) → {dynamic}

Gets intros to play before the main media item plays. V2: GET /Items/{itemId}/Intros (userId not required — auth token identifies the user)

Parameters:

Name	Type	Description
`_userid`	string
`itemid`	string

Source: source/api/sdk.v2.bs, line 135

Returns:

Type:: dynamic

(static) GetItem(userid, itemid, paramsopt) → {dynamic}

Gets an item from a user's library. V2: GET /Items/{itemId}?userId=

Parameters:

Name	Type	Attributes	Default
`userid`	string
`itemid`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 123

Returns:

Type:: dynamic

(static) GetItemsByQuery(id, paramsopt) → {dynamic}

Gets items based on a query. V2: GET /Items/?userId=

Parameters:

Name	Type	Attributes	Default	Description
`id`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 63

Returns:

Type:: dynamic

(static) GetLatestMedia(userid, paramsopt) → {dynamic}

Gets latest media. V2: GET /Items/Latest?userId=

Parameters:

Name	Type	Attributes	Default	Description
`userid`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 171

Returns:

Type:: dynamic

(static) GetLocalTrailers(_userid, itemid) → {dynamic}

Gets local trailers for an item. V2: GET /Items/{itemId}/LocalTrailers (userId not required)

Parameters:

Name	Type	Description
`_userid`	string
`itemid`	string

Source: source/api/sdk.v2.bs, line 147

Returns:

Type:: dynamic

(static) GetResumeItemsByQuery(id, paramsopt) → {dynamic}

Gets resumable items. V2: GET /UserItems/Resume?userId=

Parameters:

Name	Type	Attributes	Default	Description
`id`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 75

Returns:

Type:: dynamic

(static) GetRoot(userid) → {dynamic}

Gets the root folder from a user's library. V2: GET /Items/Root

Parameters:

Name	Type	Description
`userid`	string

Source: source/api/sdk.v2.bs, line 182

Returns:

Type:: dynamic

(static) GetSpecialFeatures(_userid, itemid) → {dynamic}

Gets special features for an item. V2: GET /Items/{itemId}/SpecialFeatures (userId not required)

Parameters:

Name	Type	Description
`_userid`	string
`itemid`	string

Source: source/api/sdk.v2.bs, line 159

Returns:

Type:: dynamic

(static) GetSuggestions(id, paramsopt) → {dynamic}

Gets suggestions. V2: GET /Items/Suggestions?userId=

Parameters:

Name	Type	Attributes	Default	Description
`id`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 87

Returns:

Type:: dynamic

(static) GetViews(id, paramsopt) → {dynamic}

Get user views. V2: GET /UserViews?userId=

Parameters:

Name	Type	Attributes	Default	Description
`id`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 110

Returns:

Type:: dynamic

(static) HeadImageURL(id, imagetypeopt, imageindexopt, paramsopt) → {dynamic}

HEAD user profile image. V2: HEAD /UserImage?userId=&type=&index=

Parameters:

Name	Type	Attributes	Default
`id`	string
`imagetype`	string	<optional>	"primary"
`imageindex`	integer	<optional>	0
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 51

Returns:

Type:: dynamic

(static) MarkFavorite(userid, itemid) → {dynamic}

Marks an item as a favorite. V2: POST /UserFavoriteItems/{itemId}?userId=

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v2.bs, line 194

Returns:

Type:: dynamic

(static) MarkPlayed(userid, itemid, paramsopt) → {dynamic}

Marks an item as played for user. V2: POST /UserPlayedItems/{itemId}?userId=

Parameters:

Name	Type	Attributes	Default
`userid`	string
`itemid`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 244

Returns:

Type:: dynamic

(static) MarkPlaying(userid, itemid, paramsopt) → {dynamic}

Reports that a user has begun playing an item. V2: POST /PlayingItems/{itemId}

Parameters:

Name	Type	Attributes	Default
`userid`	string
`itemid`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 269

Returns:

Type:: dynamic

(static) MarkStoppedPlaying(userid, itemid, paramsopt) → {dynamic}

Reports that a user has stopped playing an item. V2: DELETE /PlayingItems/{itemId}

Parameters:

Name	Type	Attributes	Default
`userid`	string
`itemid`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 282

Returns:

Type:: dynamic

(static) ReportPlayProgress(userid, itemid, paramsopt) → {dynamic}

Reports a user's playback progress. V2: POST /PlayingItems/{itemId}/Progress

Parameters:

Name	Type	Attributes	Default
`userid`	string
`itemid`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 295

Returns:

Type:: dynamic

(static) UnmarkFavorite(userid, itemid) → {dynamic}

Unmarks item as a favorite. V2: DELETE /UserFavoriteItems/{itemId}?userId=

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v2.bs, line 206

Returns:

Type:: dynamic

(static) UnmarkPlayed(userid, itemid) → {dynamic}

Marks an item as unplayed for user. V2: DELETE /UserPlayedItems/{itemId}?userId=

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v2.bs, line 256

Returns:

Type:: dynamic

(static) UpdateConfiguration(_id, bodyopt) → {dynamic}

Updates a user configuration. V2: POST /Users/Configuration (userId not required — auth token identifies the user)

Parameters:

Name	Type	Attributes	Default	Description
`_id`	string
`body`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 307

Returns:

Type:: dynamic

(static) UpdatePassword(_id, bodyopt) → {dynamic}

Updates a user's password. V2: POST /Users/Password (userId not required — auth token identifies the user)

Parameters:

Name	Type	Attributes	Default	Description
`_id`	string
`body`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 319

Returns:

Type:: dynamic

(static) UpdateRating(userid, itemid, paramsopt) → {dynamic}

Updates a user's rating for an item. V2: POST /UserItems/{itemId}/Rating?userId=

Parameters:

Name	Type	Attributes	Default
`userid`	string
`itemid`	string
`params`	object	<optional>	{}

Source: source/api/sdk.v2.bs, line 231

Returns:

Type:: dynamic