@backblaze-labs/b2-sdk - v0.2.0
    Preparing search index...

    Interface AccountInfo

    Stores B2 authorization state between requests. Implementations cache the authorize-account response and manage pools of reusable upload URLs (checkout/checkin/evict pattern).

    interface AccountInfo {
        checkoutPartUploadUrl(fileId: string): UploadUrlEntry | null;
        checkoutUploadUrl(bucketId: BucketId): UploadUrlEntry | null;
        clear(): void;
        evictPartUploadUrl(fileId: string, entry: UploadUrlEntry): void;
        evictUploadUrl(bucketId: BucketId, entry: UploadUrlEntry): void;
        getAbsoluteMinimumPartSize(): number;
        getAccountId(): string;
        getAllowedBucketId(): BucketId | null;
        getAllowedBucketIds(): readonly BucketId[] | null;
        getApiUrl(): string;
        getAuth(): AuthorizeAccountResponse | null;
        getAuthToken(): string;
        getDownloadUrl(): string;
        getRecommendedPartSize(): number;
        getS3ApiUrl(): string;
        returnPartUploadUrl(fileId: string, entry: UploadUrlEntry): void;
        returnUploadUrl(bucketId: BucketId, entry: UploadUrlEntry): void;
        setApplicationKeyId?(applicationKeyId: string): void;
        setAuth(auth: AuthorizeAccountResponse): void;
        setRealmUrl?(realmUrl: string): void;
    }

    Implemented by

    Index

    Methods

    checkoutPartUploadUrl checkoutUploadUrl clear evictPartUploadUrl evictUploadUrl getAbsoluteMinimumPartSize getAccountId getAllowedBucketId getAllowedBucketIds getApiUrl getAuth getAuthToken getDownloadUrl getRecommendedPartSize getS3ApiUrl returnPartUploadUrl returnUploadUrl setApplicationKeyId? setAuth setRealmUrl?

    Methods

    • Discard all cached authorization state and upload URLs.

      Returns void

    • Smallest allowed part size for large file uploads, in bytes.

      Returns number

    • Server-recommended part size for large file uploads, in bytes.

      Returns number

    • Parameters

      • applicationKeyId: string

      Returns void

      Persistent auth stores should implement AuthContextAwareAccountInfo. This optional hook remains for source compatibility with older integrations.

    • Parameters

      • realmUrl: string

      Returns void

      Persistent auth stores should implement AuthContextAwareAccountInfo. This optional hook remains for source compatibility with older integrations.

    Settings

    Member Visibility

    On This Page

    Methods