BoxSDKConfiguration

public struct BoxSDKConfiguration

SDK configuration specifying request related information

  • The client ID of the application requesting authentication. To get the client ID for your application, log in to your Box developer console and click the Edit Application link for the application you’re working with. In the OAuth 2 Parameters section of the configuration page, find the item labeled “client_id”. The text of that item is your application’s client ID.

    Declaration

    Swift

    public let clientId: String

  • The client secret of the application requesting authentication. To get the client secret for your application, log in to your Box developer console and click the Edit Application link for the application you’re working with. In the OAuth 2 Parameters section of the configuration page, find the item labeled “client_secret”. The text of that item is your application’s client secret.

    Declaration

    Swift

    public let clientSecret: String

  • Base URL for majority of the requests.

    Declaration

    Swift

    public let apiBaseURL: URL

  • Base URL for file upload requests.

    Declaration

    Swift

    public let uploadApiBaseURL: URL

  • URL for the OAuth2 authorization page, where users are redirected to enter their credentials

    Declaration

    Swift

    public let oauth2AuthorizeURL: URL

  • Maximum number of retries for a failed request.

    Declaration

    Swift

    public let maxRetryAttempts: Int

  • Specifies how long before token expiration date it should be refreshed.

    Declaration

    Swift

    public let tokenRefreshThreshold: TimeInterval

  • The base factor used in calculating exponential backoff delay for retries

    Declaration

    Swift

    public let retryBaseInterval: TimeInterval

  • Analytics info that is set to request headers.

    Declaration

    Swift

    public let clientAnalyticsInfo: ClientAnalyticsInfo?

  • Console log destination.

    Declaration

    Swift

    public let consoleLogDestination: ConsoleLogDestination

  • File log destination.

    Declaration

    Swift

    public let fileLogDestination: FileLogDestination?

  • An optional custom callback URL string. The URL to which Box redirects the browser when authentication completes. The user’s actual interaction with your application begins when Box redirects to this URL. If not specified, default URL is used in a format of boxsdk-clientId://boxsdkoauth2redirect with the real value of clientId.

    Declaration

    Swift

    public let callbackURL: String