Namespace: sdkV1/sdkV1/users

Source: source/api/sdk.v1.bs, line 18

Methods

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

Deletes a user's saved personal rating for an item.

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v1.bs, line 201

Returns:

Type:: dynamic

(static) GetGroupingOptions(id) → {dynamic}

Get user view grouping options.

Parameters:

Name	Type	Description
`id`	string

Source: source/api/sdk.v1.bs, line 91

Returns:

Type:: dynamic

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

Get user profile image URL.

Parameters:

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

Source: source/api/sdk.v1.bs, line 35

Returns:

Type:: dynamic

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

Gets intros to play before the main media item plays.

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v1.bs, line 125

Returns:

Type:: dynamic

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

Gets an item from a user's library.

Parameters:

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

Source: source/api/sdk.v1.bs, line 114

Returns:

Type:: dynamic

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

Gets items based on a query.

Parameters:

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

Source: source/api/sdk.v1.bs, line 59

Returns:

Type:: dynamic

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

Gets latest media.

Parameters:

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

Source: source/api/sdk.v1.bs, line 158

Returns:

Type:: dynamic

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

Gets local trailers for an item.

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v1.bs, line 136

Returns:

Type:: dynamic

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

Gets resumable items.

Parameters:

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

Source: source/api/sdk.v1.bs, line 70

Returns:

Type:: dynamic

(static) GetRoot(userid) → {dynamic}

Gets the root folder from a user's library.

Parameters:

Name	Type	Description
`userid`	string

Source: source/api/sdk.v1.bs, line 168

Returns:

Type:: dynamic

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

Gets special features for an item.

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

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

Returns:

Type:: dynamic

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

Gets suggestions.

Parameters:

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

Source: source/api/sdk.v1.bs, line 81

Returns:

Type:: dynamic

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

Get user views.

Parameters:

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

Source: source/api/sdk.v1.bs, line 102

Returns:

Type:: dynamic

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

HEAD user profile image.

Parameters:

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

Source: source/api/sdk.v1.bs, line 48

Returns:

Type:: dynamic

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

Marks an item as a favorite.

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v1.bs, line 179

Returns:

Type:: dynamic

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

Marks an item as played for user.

Parameters:

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

Source: source/api/sdk.v1.bs, line 225

Returns:

Type:: dynamic

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

Reports that a user has begun playing an item.

Parameters:

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

Source: source/api/sdk.v1.bs, line 248

Returns:

Type:: dynamic

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

Reports that a user has stopped playing an item.

Parameters:

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

Source: source/api/sdk.v1.bs, line 260

Returns:

Type:: dynamic

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

Reports a user's playback progress.

Parameters:

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

Source: source/api/sdk.v1.bs, line 272

Returns:

Type:: dynamic

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

Unmarks item as a favorite.

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v1.bs, line 190

Returns:

Type:: dynamic

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

Marks an item as unplayed for user.

Parameters:

Name	Type	Description
`userid`	string
`itemid`	string

Source: source/api/sdk.v1.bs, line 236

Returns:

Type:: dynamic

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

Updates a user configuration.

Parameters:

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

Source: source/api/sdk.v1.bs, line 283

Returns:

Type:: dynamic

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

Updates a user's password.

Parameters:

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

Source: source/api/sdk.v1.bs, line 294

Returns:

Type:: dynamic

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

Updates a user's rating for an item.

Parameters:

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

Source: source/api/sdk.v1.bs, line 213

Returns:

Type:: dynamic