Class AssetsApiClient

Hierarchy

AssetsApiClient

Index

Accessors

messages

Methods

Accessors

messages

get messages(): Messages

Make sure to call the loadMessages function before using the messages object.

Returns Messages

Methods

browse

browse(params: BrowseParams): Promise<BrowseResponse>

Returns the browse result at a given path.

remark

Note that the entire tree structure will be returned when specifying the fromRoot parameter.

Parameters
- params: BrowseParams
Returns Promise<BrowseResponse>

copy

copy(params: CopyMoveParams): Promise<BulkResponse>

Copies an entity from a given source destination to the specified target destination.

Parameters
- params: CopyMoveParams
Returns Promise<BulkResponse>

create

create(metadata: {}): Promise<Asset>

Creates an asset with the given metadata.

Parameters
- metadata: {}
  - [key: string]: any
Returns Promise<Asset>

createFolder

createFolder(params: CreateFolderParams): Promise<CreateFolderResponse>

Creates a folder at the specified path.

Parameters
- params: CreateFolderParams
Returns Promise<CreateFolderResponse>

createRelation

createRelation(metadata: CreateRelationParams): Promise<{}>

Creates a relation between two entities.

Parameters
- metadata: CreateRelationParams
Returns Promise<{}>

csrf

csrf(force?: boolean): Promise<string>

Requests a new csrf token.

remark

For the calls in this client, the token will be refreshed automatically should the token expire.

Parameters
- Default value force: boolean = false
Returns Promise<string>

fieldinfo

fieldinfo(): Promise<FieldinfoResponse>

Returns the configuration of fieldinfo of the current Assets server.

Returns Promise<FieldinfoResponse>

getProfile

getProfile(): Promise<ProfileResponse>

Returns the profile for the currently logged in user

Returns Promise<ProfileResponse>

loadMessages

loadMessages(locale?: string): Promise<{}>

Requests the configured messages for the given locale and initializes the messages object on the API client.

Parameters
- Default value locale: string = navigator.language
Returns Promise<{}>

login

login(params?: LoginParams): Promise<void | LoginResponse>

Performs a login using the configured login method.

remark

Note that the passed parameters will be disregarded when using the AssetsPluginContext. A LoginResponse will only be returned when running in standalone mode.

Parameters
- Optional params: LoginParams
Returns Promise<void | LoginResponse>

logout

logout(): Promise<void>

Performs a logout request on the server.

remark

Note that for plugin usage (since the client window is used as proxy for requests) this will result in the client being logged out.

Returns Promise<void>

move

move(params: CopyMoveParams): Promise<BulkResponse>

Moves an entity from a given source destination to the specified target destination.

Parameters
- params: CopyMoveParams
Returns Promise<BulkResponse>

remove

remove(params: RemoveParams): Promise<BulkResponse>

Permanently removes an entity from the Assets server.

Parameters
- params: RemoveParams
Returns Promise<BulkResponse>

removeRelation

removeRelation(metadata: RemoveRelationParams): Promise<BulkResponse>

Permanently removes a relation between two entities from the Assets server.

Parameters
- metadata: RemoveRelationParams
Returns Promise<BulkResponse>

search

search(params: SearchParams): Promise<SearchResponse>

Performs the specified search query on the server.

Parameters
- params: SearchParams
Returns Promise<SearchResponse>

update

update(id: string, metadata: {}): Promise<Asset>

Updates an asset with the specified metadata.

Parameters
- id: string
- metadata: {}
  - [key: string]: any
Returns Promise<Asset>

updatebulk

updatebulk(query: string, metadata: {}): Promise<BulkResponse>

Updates assets found by the given query with the specified metadata.

remark

Sets the same metadata for all assets. If you want to set different metadata for multiple assets, use updatebulkMulti instead.

Parameters
- query: string
- metadata: {}
  - [key: string]: any
Returns Promise<BulkResponse>

updatebulkMulti

updatebulkMulti(instructions: UpdateInstructionParam[]): Promise<Asset[]>

Updates specified assets with respectively specified metadata. Allows for setting different metadata per asset.

Parameters
- instructions: UpdateInstructionParam[]
Returns Promise<Asset[]>

useAutoLogin

useAutoLogin(username: string, password: string, clientType: string): void

Configure the client to start a session within the current window with the given credentials when authenticating.

Parameters
- username: string
- password: string
- clientType: string
Returns void

useLoginHandler

useLoginHandler(loginHandler: (params?: LoginParams) => Promise<any>): void

Configure the client to use a custom handler for logging in.

Parameters
- loginHandler: (params?: LoginParams) => Promise<any>
  - - (params?: LoginParams): Promise<any>
    - Parameters
      - Optional params: LoginParams
      Returns Promise<any>
Returns void

Static fromPluginContext

fromPluginContext(pluginContext: AssetsPluginContext): AssetsApiClient

Use this function to initialize the API client using an established connection with the Assets client using the AssetsPluginContext class. This ensures requests and login prompts are automatically routed through to the Assets client and thus reuses the existing user session from the Assets client window.

Parameters
- pluginContext: AssetsPluginContext
Returns AssetsApiClient

Static standalone

standalone(serverUrl: string, username: string, password: string, clientType: string): AssetsApiClient

Use this function to initialize the API client as a standalone interface with the Assets server. This means a new userSession must be instantiated in order to start querying the server. For plugin developers looking to reuse the existing userSession from the Assets client, refer to the 'fromPluginContext' function.

Parameters
- serverUrl: string
- username: string
- password: string
- clientType: string
Returns AssetsApiClient