Type Alias SpaceMethods

Type declaration

• list:function

  • list(data): Promise<{
        list: Space[];
        count: number;
    }>

  • Get a list of active spaces.

    Requires AccessScope.SpaceDiscover.

    Parameters

    • data: ScopeTarget & PaginationTarget
      • organizationId lists spaces of organization.
      • divisionId lists spaces of division.
      • teamId lists spaces of a team
      • by default lists spaces of the user
      • skip is number of spaces to skip
      • limit limits number of results (details)

    Returns Promise<{
        list: Space[];
        count: number;
    }>

    Total count and list of spaces:

    • id is the identifier of space
    • name is space display name
    • description is space description
    • storageSize is current storage size in MiB
    • maxStorageSize is maximum storage size in MiB
    • subscription is identifier of connected subscription
    • mediaAccess (MediaAccess) limits access upload media
    • status (SpaceStatus) defines space status (legacy)
    • size (SpaceSize) is physical size of space
    • communityMode (CommunityMode) switches team/individual editing
    • password always return empty string, password can't be read via RPC
    • meetingBeginTime is timestamp of meeting begin (legacy)
    • meetingEndTime is timestamp of meeting end (legacy)
    • privacy (SpaceAccessLevel) define space privacy (experimental)

    Throws

    ModuleErrors.AccessRestricted;

• create:function

  • create(data): Promise<string>

  • Create a new space.

    Requires AccessScope.SpaceCreate.

    Parameters

    • data: EditablePartOfSpace & SubscriptionTarget
      • name is space display name
      • description is space description
      • subscription (SubscriptionTarget.subscription)
      • mediaAccess (MediaAccess) limits access upload media
      • status (SpaceStatus) defines space status (legacy)
      • size (SpaceSize) is physical size of space
      • communityMode (CommunityMode) switches team/individual editing
      • password is password of space
      • meetingBeginTime is timestamp of meeting begin (legacy)
      • meetingEndTime is timestamp of meeting end (legacy)
      • privacy (SpaceAccessLevel) define space privacy (experimental)

    Returns Promise<string>

    Identifier of created space

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NoEnoughMoney; ModuleErrors.NotFound; ModuleErrors.InactiveSubscription; ModuleErrors.SubscriptionLimit; ModuleErrors.OutdatedSubscription;

• edit:function

  • edit(data): Promise<boolean>

  • Edit space settings.

    Requires AccessScope.SpaceEdit. Fields password, status and privacy require AccessScope.SpaceAccess.

    Parameters

    • data: SpaceTarget & Partial<EditablePartOfSpace>
      • spaceId is the identifier of space
      • name is space display name
      • description is space description
      • mediaAccess (MediaAccess) limits access upload media
      • status (SpaceStatus) defines space status (legacy)
      • size (SpaceSize) is physical size of space
      • communityMode (CommunityMode) switches team/individual editing
      • password is password of space
      • meetingBeginTime is timestamp of meeting begin (legacy)
      • meetingEndTime is timestamp of meeting end (legacy)
      • privacy (SpaceAccessLevel) define space privacy (experimental)

    Returns Promise<boolean>

    true if updated successful, otherwise false

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound; ModuleErrors.ClientError;

• cancel:function

  • cancel(data): Promise<string>

  • Cancel a space subscription

    Requires AccessScope.SpaceCancel.

    Parameters

    • data: SpaceTarget
      • spaceId is the identifier of space

    Returns Promise<string>

    Expire date as string, ISO 8601

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound; ModuleErrors.ClientError;

• moderators:function

  • moderators(data): Promise<string[]>

  • Get a list of space moderators.

    Requires AccessScope.SpaceAccess.

    Parameters

    • data: SpaceTarget
      • spaceId is the identifier of space

    Returns Promise<string[]>

    List of moderator's emails

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• addModerator:function

  • addModerator(data): Promise<boolean>

  • Add a new moderator.

    Requires AccessScope.SpaceAccess.

    Parameters

    • data: SpaceTarget & UserTarget
      • spaceId is the identifier of space
      • email is email of user

    Returns Promise<boolean>

    True if user was found

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• removeModerator:function

  • removeModerator(data): Promise<boolean>

  • Remove a moderator.

    Requires AccessScope.SpaceAccess.

    Parameters

    • data: SpaceTarget & UserTarget
      • spaceId is the identifier of space
      • email is email of user

    Returns Promise<boolean>

    True if user was found

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• allowList:function

  • allowList(data): Promise<string[]>
  • Beta

    Get a list of space allowlisted users.

    Requires AccessScope.SpaceAccess.

    Parameters

    • data: SpaceTarget
      • spaceId is the identifier of space

    Returns Promise<string[]>

    List of allowlisted users emails

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• addToAllowList:function

  • addToAllowList(data): Promise<boolean>
  • Beta

    Add a new allowlisted user.

    Requires AccessScope.SpaceAccess.

    Parameters

    • data: SpaceTarget & UserTarget
      • spaceId is the identifier of space
      • email is email of user

    Returns Promise<boolean>

    True if user was found

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• removeFromAllowList:function

  • removeFromAllowList(data): Promise<boolean>
  • Beta

    Remove an allowlisted user.

    Requires AccessScope.SpaceAccess.

    Parameters

    • data: SpaceTarget & UserTarget
      • spaceId is the identifier of space
      • email is email of user

    Returns Promise<boolean>

    True if user was found

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;