Cognite JavaScript SDK

Index

Classes

Interfaces

Type aliases

Functions


Type aliases

CREATE

Ƭ CREATE: "CREATE"

Defined in Groups.ts:16


Capabilities

Ƭ Capabilities: ( GroupsAcl | AssetsAcl | EventsAcl | FilesAcl | UsersAcl | ProjectsAcl | SecurityCategoriesAcl | RawAcl | TimeSeriesAcl | ApiKeysAcl | ThreeDAcl | SequencesAcl | AnalyticsAcl)[]

Defined in Groups.ts:145


DELETE

Ƭ DELETE: "DELETE"

Defined in Groups.ts:19


DONE

Ƭ DONE: "Done"

Defined in ThreeD.ts:19


DownloadProgress

Ƭ DownloadProgress: function

Defined in ThreeD.ts:149

Type declaration

▸(progressEvent: any): void

Parameters:

Name Type
progressEvent any

Returns: void


EXECUTE

Ƭ EXECUTE: "EXECUTE"

Defined in Groups.ts:17


FAILED

Ƭ FAILED: "Failed"

Defined in ThreeD.ts:20


LIST

Ƭ LIST: "LIST"

Defined in Groups.ts:15


MEMBEROF

Ƭ MEMBEROF: "MEMBEROF"

Defined in Groups.ts:20


PROCESSING

Ƭ PROCESSING: "Processing"

Defined in ThreeD.ts:22


QUEUED

Ƭ QUEUED: "Queued"

Defined in ThreeD.ts:21


READ

Ƭ READ: "READ"

Defined in Groups.ts:13


ResponseType

Ƭ ResponseType: * "arraybuffer" | "blob" | "document" | "json" | "text" | "stream" *

Defined in ThreeD.ts:142


RevisionStatus

Ƭ RevisionStatus: * DONE | FAILED | QUEUED | PROCESSING *

Defined in ThreeD.ts:23


UPDATE

Ƭ UPDATE: "UPDATE"

Defined in Groups.ts:18


WRITE

Ƭ WRITE: "WRITE"

Defined in Groups.ts:14


Functions

configure

configure(opts: Partial<SDKOptions>): SDKOptions

Defined in core.ts:101

Parameters:

Name Type
opts Partial<SDKOptions>

Returns: SDKOptions


getMetadata

getMetadata(response: any): undefined | Metadata

Defined in core.ts:164

Parameters:

Name Type
response any

Returns: undefined | Metadata


makeRequestSafeToRetry

makeRequestSafeToRetry(config: AxiosRequestConfig): void

Defined in retryRequests.ts:96

Parameters:

Name Type
config AxiosRequestConfig

Returns: void


rawDelete

rawDelete(url: string, reqOpt?: AxiosRequestConfig): Promise< void | AxiosResponse<any>>

Defined in core.ts:157

Parameters:

Name Type Default value
url string -
Default value reqOpt AxiosRequestConfig {}

Returns: Promise< void | AxiosResponse<any>>


rawGet

rawGet(url: string, reqOpt?: AxiosRequestConfig): Promise< void | AxiosResponse<any>>

Defined in core.ts:145

Parameters:

Name Type Default value
url string -
Default value reqOpt AxiosRequestConfig {}

Returns: Promise< void | AxiosResponse<any>>


rawPost

rawPost(url: string, reqOpt?: AxiosRequestConfig): Promise< void | AxiosResponse<any>>

Defined in core.ts:149

Parameters:

Name Type Default value
url string -
Default value reqOpt AxiosRequestConfig {}

Returns: Promise< void | AxiosResponse<any>>


rawPut

rawPut(url: string, reqOpt?: AxiosRequestConfig): Promise< void | AxiosResponse<any>>

Defined in core.ts:153

Parameters:

Name Type Default value
url string -
Default value reqOpt AxiosRequestConfig {}

Returns: Promise< void | AxiosResponse<any>>


setBearerToken

setBearerToken(token: string): void

Defined in core.ts:113

Parameters:

Name Type
token string

Returns: void