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;
    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;
    setAuth(auth: AuthorizeAccountResponse): void;
}

Implemented by

Index

Methods

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

Methods

checkoutPartUploadUrl

checkoutPartUploadUrl(fileId: string): UploadUrlEntry | null
Take a large-file part upload URL from the pool, or null if none available.
Parameters
- fileId: string
Returns UploadUrlEntry | null
- Defined in auth/account-info.ts:50

checkoutUploadUrl

checkoutUploadUrl(bucketId: BucketId): UploadUrlEntry | null
Take an upload URL from the pool for the given bucket, or null if none available.
Parameters
- bucketId: BucketId
Returns UploadUrlEntry | null
- Defined in auth/account-info.ts:43

clear

clear(): void
Discard all cached authorization state and upload URLs.

Returns void
- Defined in auth/account-info.ts:23

evictPartUploadUrl

evictPartUploadUrl(fileId: string, entry: UploadUrlEntry): void
Remove a part upload URL from the pool after an error.
Parameters
- fileId: string
- entry: UploadUrlEntry
Returns void
- Defined in auth/account-info.ts:54

evictUploadUrl

evictUploadUrl(bucketId: BucketId, entry: UploadUrlEntry): void
Remove an upload URL from the pool (e.g. after an upload error).
Parameters
- bucketId: BucketId
- entry: UploadUrlEntry
Returns void
- Defined in auth/account-info.ts:47

getAbsoluteMinimumPartSize

getAbsoluteMinimumPartSize(): number
Smallest allowed part size for large file uploads, in bytes.

Returns number
- Defined in auth/account-info.ts:36

getAccountId

getAccountId(): string
The authorized account ID.

Returns string
- Defined in auth/account-info.ts:32

getAllowedBucketId

getAllowedBucketId(): BucketId | null
Bucket ID the key is restricted to, or null if unrestricted.

Returns BucketId | null
- Defined in auth/account-info.ts:40

getApiUrl

getApiUrl(): string
Base URL for B2 API calls.

Returns string
- Defined in auth/account-info.ts:26

getAuth

getAuth(): AuthorizeAccountResponse | null
Return the current authorization response, or null if not authorized.

Returns AuthorizeAccountResponse | null
- Defined in auth/account-info.ts:21

getAuthToken

getAuthToken(): string
Current authorization token.

Returns string
- Defined in auth/account-info.ts:30

getDownloadUrl

getDownloadUrl(): string
Base URL for file downloads.

Returns string
- Defined in auth/account-info.ts:28

getRecommendedPartSize

getRecommendedPartSize(): number
Server-recommended part size for large file uploads, in bytes.

Returns number
- Defined in auth/account-info.ts:34

getS3ApiUrl

getS3ApiUrl(): string
Base URL for the S3-compatible API.

Returns string
- Defined in auth/account-info.ts:38

returnPartUploadUrl

returnPartUploadUrl(fileId: string, entry: UploadUrlEntry): void
Return a still-valid part upload URL to the pool for reuse.
Parameters
- fileId: string
- entry: UploadUrlEntry
Returns void
- Defined in auth/account-info.ts:52

returnUploadUrl

returnUploadUrl(bucketId: BucketId, entry: UploadUrlEntry): void
Return a still-valid upload URL to the pool for reuse.
Parameters
- bucketId: BucketId
- entry: UploadUrlEntry
Returns void
- Defined in auth/account-info.ts:45

setAuth

setAuth(auth: AuthorizeAccountResponse): void
Store a fresh authorization response, replacing any previous state.
Parameters
- auth: AuthorizeAccountResponse
Returns void
- Defined in auth/account-info.ts:19

Interface AccountInfo

Implemented by

Index

Methods

Methods

checkoutPartUploadUrl

Parameters

Returns UploadUrlEntry | null

checkoutUploadUrl

Parameters

Returns UploadUrlEntry | null

clear

Returns void

evictPartUploadUrl

Parameters

Returns void

evictUploadUrl

Parameters

Returns void

getAbsoluteMinimumPartSize

Returns number

getAccountId

Returns string

getAllowedBucketId

Returns BucketId | null

getApiUrl

Returns string

getAuth

Returns AuthorizeAccountResponse | null

getAuthToken

Returns string

getDownloadUrl

Returns string

getRecommendedPartSize

Returns number

getS3ApiUrl

Returns string

returnPartUploadUrl

Parameters

Returns void

returnUploadUrl

Parameters

Returns void

setAuth

Parameters

Returns void

Settings

On This Page