Skip to content

WatchLaterQueueEssentials.md

Latest commit

 

History

History
121 lines (93 loc) · 6.25 KB

WatchLaterQueueEssentials.md

File metadata and controls

121 lines (93 loc) · 6.25 KB
Raw

WatchLaterQueueEssentials — operations

Accessor: client.WatchLaterQueueEssentials · Source: src/VimeoApi/Api/WatchLaterQueueEssentials.cs · 8 operations

Type sources: the file declaring each type an operation names (RawError excluded — see sdk-map.md).

AddVideoToWatchLater

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: AddVideoToWatchLater(AddVideoToWatchLaterRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: UserId, VideoId
  • Returns: void (Task)
  • Error: ApiException<RawError> — Case B
Type Source
AddVideoToWatchLaterRequest src/VimeoApi/Requests/WatchLaterQueueEssentials/AddVideoToWatchLaterRequest.cs

AddVideoToWatchLaterAlt1

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: AddVideoToWatchLaterAlt1(AddVideoToWatchLaterAlt1Request request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: VideoId
  • Returns: void (Task)
  • Error: ApiException<RawError> — Case B
Type Source
AddVideoToWatchLaterAlt1Request src/VimeoApi/Requests/WatchLaterQueueEssentials/AddVideoToWatchLaterAlt1Request.cs

CheckWatchLaterQueue

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: CheckWatchLaterQueue(CheckWatchLaterQueueRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: UserId, VideoId
  • Returns: Video
  • Error: ApiException<CheckWatchLaterQueueError> — Case A (typed)
  • Error accessors: TryGetLegacyError(out LegacyError) [404] · TryGetRawError(out RawError) [fallback]
Type Source
CheckWatchLaterQueueRequest src/VimeoApi/Requests/WatchLaterQueueEssentials/CheckWatchLaterQueueRequest.cs
Video src/VimeoApi/Models/Video.cs
CheckWatchLaterQueueError src/VimeoApi/Errors/CheckWatchLaterQueueError.cs
LegacyError src/VimeoApi/Models/LegacyError.cs

CheckWatchLaterQueueAlt1

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: CheckWatchLaterQueueAlt1(CheckWatchLaterQueueAlt1Request request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: VideoId
  • Returns: Video
  • Error: ApiException<CheckWatchLaterQueueAlt1Error> — Case A (typed)
  • Error accessors: TryGetLegacyError(out LegacyError) [404] · TryGetRawError(out RawError) [fallback]
Type Source
CheckWatchLaterQueueAlt1Request src/VimeoApi/Requests/WatchLaterQueueEssentials/CheckWatchLaterQueueAlt1Request.cs
Video src/VimeoApi/Models/Video.cs
CheckWatchLaterQueueAlt1Error src/VimeoApi/Errors/CheckWatchLaterQueueAlt1Error.cs
LegacyError src/VimeoApi/Models/LegacyError.cs

DeleteVideoFromWatchLater

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: DeleteVideoFromWatchLater(DeleteVideoFromWatchLaterRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: UserId, VideoId
  • Returns: void (Task)
  • Error: ApiException<RawError> — Case B
Type Source
DeleteVideoFromWatchLaterRequest src/VimeoApi/Requests/WatchLaterQueueEssentials/DeleteVideoFromWatchLaterRequest.cs

DeleteVideoFromWatchLaterAlt1

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: DeleteVideoFromWatchLaterAlt1(DeleteVideoFromWatchLaterAlt1Request request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: VideoId
  • Returns: void (Task)
  • Error: ApiException<RawError> — Case B
Type Source
DeleteVideoFromWatchLaterAlt1Request src/VimeoApi/Requests/WatchLaterQueueEssentials/DeleteVideoFromWatchLaterAlt1Request.cs

GetWatchLaterQueue

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: GetWatchLaterQueue(GetWatchLaterQueueRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: UserId
  • Query params (wire ← C#): direction ← Direction, filter ← Filter, filter_embeddable ← FilterEmbeddable, page ← Page, per_page ← PerPage, query ← Query, sort ← Sort
  • Returns: VideoConnection
  • Error: ApiException<RawError> — Case B
Type Source
GetWatchLaterQueueRequest src/VimeoApi/Requests/WatchLaterQueueEssentials/GetWatchLaterQueueRequest.cs
Direction src/VimeoApi/Models/Enums/Direction.cs
Filter3 src/VimeoApi/Models/Enums/Filter3.cs
Sort15 src/VimeoApi/Models/Enums/Sort15.cs
VideoConnection src/VimeoApi/Models/VideoConnection.cs

GetWatchLaterQueueAlt1

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: GetWatchLaterQueueAlt1(GetWatchLaterQueueAlt1Request request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
  • Query params (wire ← C#): direction ← Direction, filter ← Filter, filter_embeddable ← FilterEmbeddable, page ← Page, per_page ← PerPage, query ← Query, sort ← Sort
  • Returns: VideoConnection
  • Error: ApiException<RawError> — Case B
Type Source
GetWatchLaterQueueAlt1Request src/VimeoApi/Requests/WatchLaterQueueEssentials/GetWatchLaterQueueAlt1Request.cs
Direction src/VimeoApi/Models/Enums/Direction.cs
Filter3 src/VimeoApi/Models/Enums/Filter3.cs
Sort15 src/VimeoApi/Models/Enums/Sort15.cs
VideoConnection src/VimeoApi/Models/VideoConnection.cs