Interface LocationCloudStore

Description

Instance of location cloud store which has a similar interface as cloud store.

interface LocationCloudStore {
    deleteValue(key, readOptions, onDeleted, onError): void;
    getTypeName(): string;
    getValue(key, readOptions, onRetrieved, onError): void;
    isOfType(type): boolean;
    isSame(other): boolean;
    listValues(listOptions, onRetrieved, onError): void;
    setValue(key, value, writeOptions, onSaved, onError): void;
}

Hierarchy (view full)

Methods

deleteValue getTypeName getValue isOfType isSame listValues setValue

Methods

deleteValue

  • deleteValue(key, readOptions, onDeleted, onError): void

  • Parameters

    • key: string
    • readOptions: CloudStorageReadOptions
    • onDeleted: (() => void)
        • (): void

        • Returns void

    • onError: ((code, description) => void)
        • (code, description): void

        • Parameters

          • code: string
          • description: string

          Returns void

    Returns void

    Description

    Deletes a value on the location cloud store. Note: when updating a value, the scope and collection must match that of the original value.

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

getValue

  • getValue(key, readOptions, onRetrieved, onError): void

  • Parameters

    • key: string
    • readOptions: CloudStorageReadOptions
    • onRetrieved: ((key, value, collection) => void)
        • (key, value, collection): void

        • Parameters

          Returns void

    • onError: ((code, description) => void)
        • (code, description): void

        • Parameters

          • code: string
          • description: string

          Returns void

    Returns void

    Description

    Gets a value on the location cloud store. Note: when updating a value, the scope and collection must match that of the original value.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

listValues

  • listValues(listOptions, onRetrieved, onError): void

  • Parameters

    • listOptions: CloudStorageListOptions
    • onRetrieved: ((values, cursor, collection) => void)
        • (values, cursor, collection): void

        • Parameters

          Returns void

    • onError: ((code, description) => void)
        • (code, description): void

        • Parameters

          • code: string
          • description: string

          Returns void

    Returns void

    Description

    List values on the location cloud store. Note: when updating a value, the scope and collection must match that of the original value.

setValue

  • setValue(key, value, writeOptions, onSaved, onError): void

  • Parameters

    • key: string
    • value: string | number | boolean | vec3 | vec2 | vec4 | quat | mat4 | mat3 | mat2
    • writeOptions: CloudStorageWriteOptions
    • onSaved: (() => void)
        • (): void

        • Returns void

    • onError: ((code, description) => void)
        • (code, description): void

        • Parameters

          • code: string
          • description: string

          Returns void

    Returns void

    Description

    Create/update a value on the location cloud store. Note: when updating a value, the scope and collection must match that of the original value.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc