Documentation
OAuth.OAuthVideos
Constructors
constructor
• new OAuthVideos(oauth)
Parameters
| Name | Type |
|---|---|
oauth | OAuth |
Defined in
Properties
oauth
• oauth: OAuth
Defined in
Methods
deleteVideo
▸ deleteVideo(videoResolvable): Promise<void>
Deletes a Video. Last tested NEVER
Parameters
| Name | Type | Description |
|---|---|---|
videoResolvable | VideoResolvable | The video to delete. |
Returns
Promise<void>
Defined in
getMyRatings
▸ getMyRatings(videoResolvables): Promise<{ rating: "none" | "like" | "dislike" | "unspecified" ; videoId: string }[]>
Retrieve your rating on Videos.
Last tested 05/18/2020 11:48. PASSING
Parameters
| Name | Type | Description |
|---|---|---|
videoResolvables | VideoResolvable[] | The video(s) to retrieve your rating from. |
Returns
Promise<{ rating: "none" | "like" | "dislike" | "unspecified" ; videoId: string }[]>
Defined in
getVideoAbuseReportReasons
▸ getVideoAbuseReportReasons(): Promise<VideoAbuseReportReason[]>
Gets a list of VideoAbuseReportReasons. Last tested 05/18/2020 11:48. PASSING
Returns
Promise<VideoAbuseReportReason[]>
Defined in
rateVideo
▸ rateVideo(videoResolvable, rating): Promise<void>
Like, dislike, or remove a rating from a Video. Last tested 05/18/2020 11:48. PASSING
Parameters
| Name | Type | Description |
|---|---|---|
videoResolvable | VideoResolvable | The video to rate. |
rating | "none" | "like" | "dislike" | The rating to give the video. |
Returns
Promise<void>
Defined in
reportAbuse
▸ reportAbuse(videoResolvable, reasonId, secondaryReasonId?, comments?, language?): Promise<void>
Report a Video for abuse.
Last tested NEVER
Parameters
| Name | Type | Description |
|---|---|---|
videoResolvable | VideoResolvable | The video to report. |
reasonId | string | The reason for reporting. (IDs can be found here) |
secondaryReasonId? | string | An optional second reason for reporting. |
comments? | string | Any additional information. |
language? | string | The language that the reporter speaks. |
Returns
Promise<void>
Defined in
setThumbnail
▸ setThumbnail(videoResolvable, image): Promise<{ default?: Thumbnail ; high?: Thumbnail ; maxres?: Thumbnail ; medium?: Thumbnail ; standard?: Thumbnail }>
Sets a new Thumbnail for a Video.
Last tested 05/18/2020 11:48. PASSING
Parameters
| Name | Type | Description |
|---|---|---|
videoResolvable | VideoResolvable | The video to set the thumbnail for. |
image | Image | The image data and type to upload. |
Returns
Promise<{ default?: Thumbnail ; high?: Thumbnail ; maxres?: Thumbnail ; medium?: Thumbnail ; standard?: Thumbnail }>
Defined in
updateVideo
▸ updateVideo(video): Promise<Video>
Updates a Video.
If your request does not specify a value for a property that already has a value,
the property's existing value will be deleted.
Last tested NEVER
Parameters
| Name | Type | Description |
|---|---|---|
video | VideoUpdateResource | The updated video object. |
Returns
Promise<Video>