Convergence JavaScript Client API Documentation 1.0.0-rc.12
Dev Guide
Options
Menu

Class ModelPermissionManager

Use this class to manage or query the permissions of a particular RealTimeModel.

Hierarchy

  • ModelPermissionManager

Index

Accessors

Methods

Accessors

modelId

  • get modelId(): string

  • The id of the model this permission manager works with.

    Returns string

Methods

getAllUserPermissions

getOverridesCollection

  • getOverridesCollection(): Promise<boolean>

  • Determines if this model overrides the world permissions from the model's collection.

    Returns Promise<boolean>

    True if the model overrides it's collection's world permissions.

getPermissions

  • Gets the permissions of the local user for this model

    Returns Promise<ModelPermissions>

getUserPermissions

getWorldPermissions

  • Gets the model's world permissions.

    Returns Promise<ModelPermissions>

    The model's world permissions.

removeUserPermissions

setAllUserPermissions

setOverridesCollection

  • setOverridesCollection(overrideCollection: boolean): Promise<void>

  • Sets this model to override it's collection's world permissions or not.

    Parameters

    • overrideCollection: boolean

      True to override this model's collection world permissions.

    Returns Promise<void>

setUserPermissions

setWorldPermissions