Interface AssetsApi

interface AssetsApi {
    delete(ref: string): Promise<AssetsDeleteResult>;
    delete(args: AssetsDeleteArgs): Promise<AssetsDeleteResult>;
    publish(
        content: AssetContent,
        options: AssetsPublishOptions,
    ): Promise<AssetsPublishResult>;
    publish(args: AssetsPublishArgs): Promise<AssetsPublishResult>;
}

Index

Methods

Methods

delete

delete(ref: string): Promise<AssetsDeleteResult>
Remove a host-chrome asset produced by this project. The host rejects refs owned by another project and treats already-missing refs as idempotent.
Parameters
- ref: string
Returns Promise<AssetsDeleteResult>
delete(args: AssetsDeleteArgs): Promise<AssetsDeleteResult>
Parameters
- args: AssetsDeleteArgs
Returns Promise<AssetsDeleteResult>

publish

publish(
content: AssetContent,
options: AssetsPublishOptions,
): Promise<AssetsPublishResult>
Publish candidate host-chrome material. Call only from an explicit user gesture; the host may prompt before installing or updating the asset ref.
Parameters
- content: AssetContent
- options: AssetsPublishOptions
Returns Promise<AssetsPublishResult>
publish(args: AssetsPublishArgs): Promise<AssetsPublishResult>
Parameters
- args: AssetsPublishArgs
Returns Promise<AssetsPublishResult>