Skip to content

GroupsSubscriptions.md

Latest commit

 

History

History
72 lines (56 loc) · 3.59 KB

GroupsSubscriptions.md

File metadata and controls

72 lines (56 loc) · 3.59 KB
Raw

GroupsSubscriptions — operations

Accessor: client.GroupsSubscriptions · Source: src/VimeoApi/Api/GroupsSubscriptions.cs · 4 operations

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

JoinGroup

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

JoinGroupAlt1

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

LeaveGroup

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

LeaveGroupAlt1

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