Class DataTransferManager

Index

Constructors

Properties

isDeferredExperimentEnabled

Methods

changeBiomeMapping closeSession createSetting getRegisteredAccessors openSession requestBiomeConfig requestData requestIdentifiers sendData sendDataToClipboard

Constructors

`Private`constructor

new DataTransferManager(): DataTransferManager
Returns DataTransferManager

Properties

`Readonly`isDeferredExperimentEnabled

isDeferredExperimentEnabled: boolean

Throws

This property can throw when used.

World Ready

This property can't be read in early-execution mode.

Methods

changeBiomeMapping

changeBiomeMapping(
    biomeIdentifier: string,
    collectionUniqueId: string,
    identifier: string,
): void
Parameters
- biomeIdentifier: string
- collectionUniqueId: string
- identifier: string
Returns void
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

closeSession

closeSession(collectionUniqueId: string): void
Parameters
- collectionUniqueId: string
Returns void
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

createSetting

createSetting(
    collectionUniqueId: string,
    identifier: string,
    jsonData: string,
    lockToBiome: boolean,
): Promise<DataTransferCreateSettingResponse>
Parameters
- collectionUniqueId: string
- identifier: string
- jsonData: string
- lockToBiome: boolean
Returns Promise<DataTransferCreateSettingResponse>
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getRegisteredAccessors

getRegisteredAccessors(): DataTransferCollectionNameData[]
Returns DataTransferCollectionNameData[]
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

openSession

openSession(collectionUniqueId: string): void
Parameters
- collectionUniqueId: string
Returns void
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

requestBiomeConfig

requestBiomeConfig(
biomeIdentifier: string,
): Promise<DataTransferBiomeConfigData>
Parameters
- biomeIdentifier: string
Returns Promise<DataTransferBiomeConfigData>
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

requestData

requestData(
collectionUniqueId: string,
options?: DataTransferRequestDataOptions,
): Promise<DataTransferRequestResponse>
Parameters
- collectionUniqueId: string
- Optionaloptions: DataTransferRequestDataOptions
Returns Promise<DataTransferRequestResponse>
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

requestIdentifiers

requestIdentifiers(
collectionUniqueId: string,
): Promise<DataTransferRequestIdentifiersResponse>
Parameters
- collectionUniqueId: string
Returns Promise<DataTransferRequestIdentifiersResponse>
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

sendData

sendData(
    collectionUniqueId: string,
    jsonData: string,
    options?: DataTransferSendDataOptions,
): void
Parameters
- collectionUniqueId: string
- jsonData: string
- Optionaloptions: DataTransferSendDataOptions
Returns void
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

sendDataToClipboard

sendDataToClipboard(jsonData: string): void
Parameters
- jsonData: string
Returns void
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.