Class LegacyElvisApiWrapper

deprecated: Do not use this class for new integrations/plugins!
description: This wrapper can be used to imitate the old ElvisAPI object and is intended to ease the transition to the new AssetsApiClient object.

Hierarchy

LegacyElvisApiWrapper

Index

Constructors

constructor

Properties

Accessors

messages

Methods

Constructors

constructor

new LegacyElvisApiWrapper(apiClient: AssetsApiClient): LegacyElvisApiWrapper

Parameters
- apiClient: AssetsApiClient
Returns LegacyElvisApiWrapper

Properties

useAutoLogin

useAutoLogin: any = this.apiClient.useAutoLogin.bind(this.apiClient)

useLoginHandler

useLoginHandler: any = this.apiClient.useLoginHandler.bind(this.apiClient)

Accessors

messages

get messages(): Messages

Returns Messages

Methods

browse

browse(params: BrowseParams, callbackHandler?: any): void

Parameters
- params: BrowseParams
- Optional callbackHandler: any
Returns void

copy

copy(params: CopyMoveParams, successHandler?: any): void

Parameters
- params: CopyMoveParams
- Optional successHandler: any
Returns void

create

create(metadata: {}, successHandler?: any): void

Parameters
- metadata: {}
  - [key: string]: any
- Optional successHandler: any
Returns void

createFolder

createFolder(params: CreateFolderParams, successHandler?: any): void

Parameters
- params: CreateFolderParams
- Optional successHandler: any
Returns void

createRelation

createRelation(params: CreateRelationParams, successHandler?: any): void

Parameters
- params: CreateRelationParams
- Optional successHandler: any
Returns void

csrf

csrf(successHandler?: any): void

Parameters
- Optional successHandler: any
Returns void

fieldinfo

fieldinfo(successHandler?: any): void

Parameters
- Optional successHandler: any
Returns void

getProfile

getProfile(successHandler?: any): void

Parameters
- Optional successHandler: any
Returns void

loadMessages

loadMessages(_progressHandler?: any, successHandler?: any, locale?: string): void

Parameters
- Optional _progressHandler: any
- Optional successHandler: any
- Optional locale: string
Returns void

login

login(_username?: string, _password?: string, successHandler?: any, data?: any): void

Parameters
- Optional _username: string
- Optional _password: string
- Optional successHandler: any
- Optional data: any
Returns void

logout

logout(successHandler?: any): void

Parameters
- Optional successHandler: any
Returns void

move

move(params: CopyMoveParams, successHandler?: any): void

Parameters
- params: CopyMoveParams
- Optional successHandler: any
Returns void

remove

remove(params: RemoveParams, successHandler?: any): void

Parameters
- params: RemoveParams
- Optional successHandler: any
Returns void

removeRelation

removeRelation(params: RemoveRelationParams, successHandler?: any): void

Parameters
- params: RemoveRelationParams
- Optional successHandler: any
Returns void

search

search(params: SearchParams, callbackHandler?: any): void

Parameters
- params: SearchParams
- Optional callbackHandler: any
Returns void

update

update(id: string, metadata: {}, successHandler?: any): void

Parameters
- id: string
- metadata: {}
  - [key: string]: any
- Optional successHandler: any
Returns void

updatebulk

updatebulk(query: string, metadata: {}, successHandler?: any): void

Parameters
- query: string
- metadata: {}
  - [key: string]: any
- Optional successHandler: any
Returns void

useLoginPage

useLoginPage(url: string): void

Parameters
- url: string
Returns void

usePluginContextAuthentication

usePluginContextAuthentication(): void

Returns void