Skip to content

ChannelsSubscriptionsAndSubscribers.md

Latest commit

 

History

History
118 lines (93 loc) · 6.79 KB

ChannelsSubscriptionsAndSubscribers.md

File metadata and controls

118 lines (93 loc) · 6.79 KB
Raw

ChannelsSubscriptionsAndSubscribers — operations

Accessor: client.ChannelsSubscriptionsAndSubscribers · Source: src/VimeoApi/Api/ChannelsSubscriptionsAndSubscribers.cs · 7 operations

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

CheckIfUserSubscribedToChannel

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

CheckIfUserSubscribedToChannelAlt1

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

GetChannelSubscribers

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: GetChannelSubscribers(GetChannelSubscribersRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: ChannelId, Filter
  • Query params (wire ← C#): filter ← Filter, direction ← Direction, page ← Page, per_page ← PerPage, query ← Query, sort ← Sort
  • Returns: UserConnection
  • Error: ApiException<GetChannelSubscribersError> — Case A (typed)
  • Error accessors: TryGetLegacyError(out LegacyError) [404] · TryGetRawError(out RawError) [fallback]
Type Source
GetChannelSubscribersRequest src/VimeoApi/Requests/ChannelsSubscriptionsAndSubscribers/GetChannelSubscribersRequest.cs
Filter2 src/VimeoApi/Models/Enums/Filter2.cs
Direction src/VimeoApi/Models/Enums/Direction.cs
Sort8 src/VimeoApi/Models/Enums/Sort8.cs
UserConnection src/VimeoApi/Models/UserConnection.cs
GetChannelSubscribersError src/VimeoApi/Errors/GetChannelSubscribersError.cs
LegacyError src/VimeoApi/Models/LegacyError.cs

SubscribeToChannel

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

SubscribeToChannelAlt1

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

UnsubscribeFromChannel

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

UnsubscribeFromChannelAlt1

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