Interface IIntegrationsClient

Namespace

TorBoxSDK.Main.Integrations

Assembly

TorBoxSDK.dll

Defines operations for managing third-party integrations through the TorBox Main API.

public interface IIntegrationsClient

Methods

CreateDropboxJobAsync(CreateIntegrationJobRequest, CancellationToken)

Creates a Dropbox integration job.

Task<TorBoxResponse<IntegrationJob>> CreateDropboxJobAsync(CreateIntegrationJobRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateIntegrationJobRequest

The integration job request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IntegrationJob>>

The created job details.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

CreateGofileJobAsync(CreateIntegrationJobRequest, CancellationToken)

Creates a GoFile integration job.

Task<TorBoxResponse<IntegrationJob>> CreateGofileJobAsync(CreateIntegrationJobRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateIntegrationJobRequest

The integration job request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IntegrationJob>>

The created job details.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

CreateGoogleDriveJobAsync(CreateIntegrationJobRequest, CancellationToken)

Creates a Google Drive integration job.

Task<TorBoxResponse<IntegrationJob>> CreateGoogleDriveJobAsync(CreateIntegrationJobRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateIntegrationJobRequest

The integration job request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IntegrationJob>>

The created job details.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

CreateOneFichierJobAsync(CreateIntegrationJobRequest, CancellationToken)

Creates a 1Fichier integration job.

Task<TorBoxResponse<IntegrationJob>> CreateOneFichierJobAsync(CreateIntegrationJobRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateIntegrationJobRequest

The integration job request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IntegrationJob>>

The created job details.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

CreateOnedriveJobAsync(CreateIntegrationJobRequest, CancellationToken)

Creates a OneDrive integration job.

Task<TorBoxResponse<IntegrationJob>> CreateOnedriveJobAsync(CreateIntegrationJobRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateIntegrationJobRequest

The integration job request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IntegrationJob>>

The created job details.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

CreatePixeldrainJobAsync(CreateIntegrationJobRequest, CancellationToken)

Creates a Pixeldrain integration job.

Task<TorBoxResponse<IntegrationJob>> CreatePixeldrainJobAsync(CreateIntegrationJobRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateIntegrationJobRequest

The integration job request.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IntegrationJob>>

The created job details.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

DeleteJobAsync(long, CancellationToken)

Deletes a specific integration job.

Task<TorBoxResponse> DeleteJobAsync(long jobId, CancellationToken cancellationToken = default)

Parameters

jobId long

The unique identifier of the job to delete.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse>

The API response.

Exceptions

TorBoxException

Thrown when the API returns an error.

GetJobAsync(long, CancellationToken)

Retrieves the status of a specific integration job.

Task<TorBoxResponse<IntegrationJob>> GetJobAsync(long jobId, CancellationToken cancellationToken = default)

Parameters

jobId long

The unique identifier of the job.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IntegrationJob>>

The integration job details.

Exceptions

TorBoxException

Thrown when the API returns an error.

GetJobsAsync(CancellationToken)

Retrieves all integration jobs for the authenticated user.

Task<TorBoxResponse<IReadOnlyList<IntegrationJob>>> GetJobsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IReadOnlyList<IntegrationJob>>>

A list of integration jobs.

Exceptions

TorBoxException

Thrown when the API returns an error.

GetJobsByHashAsync(string, CancellationToken)

Retrieves integration jobs associated with a specific hash.

Task<TorBoxResponse<IReadOnlyList<IntegrationJob>>> GetJobsByHashAsync(string hash, CancellationToken cancellationToken = default)

Parameters

hash string

The hash to search jobs for.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IReadOnlyList<IntegrationJob>>>

A list of integration jobs for the specified hash.

Exceptions

ArgumentNullException

Thrown when hash is null.

ArgumentException

Thrown when hash is empty.

TorBoxException

Thrown when the API returns an error.

GetLinkedDiscordRolesAsync(LinkedRolesRequest, CancellationToken)

Retrieves linked Discord roles for the authenticated user.

Task<TorBoxResponse<LinkedDiscordRoles>> GetLinkedDiscordRolesAsync(LinkedRolesRequest request, CancellationToken cancellationToken = default)

Parameters

request LinkedRolesRequest

The linked roles request containing the Discord token.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<LinkedDiscordRoles>>

The linked Discord roles data.

Exceptions

ArgumentNullException

Thrown when request is null.

TorBoxException

Thrown when the API returns an error.

GetOAuthMeAsync(CancellationToken)

Retrieves the authenticated user's connected OAuth integrations.

Task<TorBoxResponse<IReadOnlyDictionary<string, bool>>> GetOAuthMeAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<IReadOnlyDictionary<string, bool>>>

A dictionary of provider names to connection status.

Exceptions

TorBoxException

Thrown when the API returns an error.

OAuthCallbackAsync(string, CancellationToken)

Handles the OAuth callback for the specified provider.

Task<TorBoxResponse<OAuthCallback>> OAuthCallbackAsync(string provider, CancellationToken cancellationToken = default)

Parameters

provider string

The OAuth provider name.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<OAuthCallback>>

The callback response data.

Exceptions

ArgumentNullException

Thrown when provider is null.

ArgumentException

Thrown when provider is empty.

TorBoxException

Thrown when the API returns an error.

OAuthRedirectAsync(string, CancellationToken)

Initiates an OAuth redirect for the specified provider.

Task<TorBoxResponse<string>> OAuthRedirectAsync(string provider, CancellationToken cancellationToken = default)

Parameters

provider string

The OAuth provider name (e.g., "google", "dropbox").

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<string>>

The redirect URL as a string.

Exceptions

ArgumentNullException

Thrown when provider is null.

ArgumentException

Thrown when provider is empty.

TorBoxException

Thrown when the API returns an error.

OAuthRegisterAsync(OAuthRegisterRequest, CancellationToken)

Registers an OAuth integration with the specified provider.

Task<TorBoxResponse> OAuthRegisterAsync(OAuthRegisterRequest request, CancellationToken cancellationToken = default)

Parameters

request OAuthRegisterRequest

The registration request containing the provider, authorization code and redirect URI.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse>

The API response.

Exceptions

ArgumentNullException

Thrown when request is null, or when the provider in request is null.

ArgumentException

Thrown when the provider in request is empty.

TorBoxException

Thrown when the API returns an error.

OAuthSuccessAsync(string, CancellationToken)

Handles the OAuth success endpoint for the specified provider.

Task<TorBoxResponse<OAuthSuccess>> OAuthSuccessAsync(string provider, CancellationToken cancellationToken = default)

Parameters

provider string

The OAuth provider name.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse<OAuthSuccess>>

The success response data.

Exceptions

ArgumentNullException

Thrown when provider is null.

ArgumentException

Thrown when provider is empty.

TorBoxException

Thrown when the API returns an error.

OAuthUnregisterAsync(string, CancellationToken)

Unregisters an OAuth integration with the specified provider.

Task<TorBoxResponse> OAuthUnregisterAsync(string provider, CancellationToken cancellationToken = default)

Parameters

provider string

The OAuth provider name.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TorBoxResponse>

The API response.

Exceptions

ArgumentNullException

Thrown when provider is null.

ArgumentException

Thrown when provider is empty.

TorBoxException

Thrown when the API returns an error.