Class MSC3089TreeSpace

constructor

• new MSC3089TreeSpace(client, roomId): MSC3089TreeSpace

• Parameters

  • client: MatrixClient
  • roomId: string

  Returns MSC3089TreeSpace

Readonly room

Readonly roomId

id

• get id(): string

• Syntactic sugar for room ID of the Space.

  Returns string

isTopLevel

• get isTopLevel(): boolean

• Whether or not this is a top level space.

  Returns boolean

createDirectory

• createDirectory(name): Promise<MSC3089TreeSpace>

• Creates a directory under this tree space, represented as another tree space.

  Parameters

  • name: string

    The name for the directory.

  Returns Promise<MSC3089TreeSpace>

  Promise which resolves to the created directory.

createFile

• createFile(name, encryptedContents, info, additionalContent?): Promise<ISendEventResponse>

• Creates (uploads) a new file to this tree. The file must have already been encrypted for the room. The file contents are in a type that is compatible with MatrixClient.uploadContent().

  Parameters

  • name: string

    The name of the file.
  • encryptedContents: XMLHttpRequestBodyInit

    The encrypted contents.
  • info: Partial<IEncryptedFile>

    The encrypted file information.
  • Optional additionalContent: IContent

    Optional event content fields to include in the message.

  Returns Promise<ISendEventResponse>

  Promise which resolves to the file event's sent response.

delete

• delete(): Promise<void>

• Deletes the tree, kicking all members and deleting all subdirectories.

  Returns Promise<void>

  Promise which resolves when complete.

getDirectories

• getDirectories(): MSC3089TreeSpace[]

• Gets a list of all known immediate subdirectories to this tree space.

  Returns MSC3089TreeSpace[]

  The tree spaces (directories). May be empty, but not null.

getDirectory

• getDirectory(roomId): undefined | MSC3089TreeSpace

• Gets a subdirectory of a given ID under this tree space. Note that this will not recurse into children and instead only look one level deep.

  Parameters

  • roomId: string

    The room ID (directory ID) to find.

  Returns undefined | MSC3089TreeSpace

  The directory, or undefined if not found.

getFile

• getFile(fileEventId): null | MSC3089Branch

• Retrieves a file from the tree.

  Parameters

  • fileEventId: string

    The event ID of the file.

  Returns null | MSC3089Branch

  The file, or null if not found.

getOrder

• getOrder(): number

• Gets the current order index for this directory. Note that if this is the top level space then -1 will be returned.

  Returns number

  The order index of this space.

getPermissions

• getPermissions(userId): TreePermissions

• Gets the current permissions of a user. Note that any users missing explicit permissions (or not in the space) will be considered Viewers. Appropriate membership checks need to be performed elsewhere.

  Parameters

  • userId: string

    The user ID to check permissions of.

  Returns TreePermissions

  The permissions for the user, defaulting to Viewer.

invite

• invite(userId, andSubspaces?, shareHistoryKeys?): Promise<void>

• Invites a user to the tree space. They will be given the default Viewer permission level unless specified elsewhere.

  Parameters

  • userId: string

    The user ID to invite.
  • andSubspaces: boolean = true

    True (default) to invite the user to all directories/subspaces too, recursively.
  • shareHistoryKeys: boolean = true

    True (default) to share encryption keys with the invited user. This will allow them to decrypt the events (files) in the tree. Keys will not be shared if the room is lacking appropriate history visibility (by default, history visibility is "shared" in trees, which is an appropriate visibility for these purposes).

  Returns Promise<void>

  Promise which resolves when complete.

listAllFiles

• listAllFiles(): MSC3089Branch[]

• Gets an array of all known files for the tree, including inactive/invalid ones.

  Returns MSC3089Branch[]

  The known files. May be empty, but not null.

listFiles

• listFiles(): MSC3089Branch[]

• Gets an array of all known files for the tree.

  Returns MSC3089Branch[]

  The known files. May be empty, but not null.

setName

• setName(name): Promise<void>

• Sets the name of the tree space.

  Parameters

  • name: string

    The new name for the space.

  Returns Promise<void>

  Promise which resolves when complete.

setOrder

• setOrder(index): Promise<void>

• Sets the order index for this directory within its parent. Note that if this is a top level space then an error will be thrown. -1 can be used to move the child to the start, and numbers larger than the number of children can be used to move the child to the end.

  Parameters

  • index: number

    The new order index for this space.

  Returns Promise<void>

  Promise which resolves when complete.

  Throws

  Throws if this is a top level space.

setPermissions

• setPermissions(userId, role): Promise<void>

• Sets the permissions of a user to the given role. Note that if setting a user to Owner then they will NOT be able to be demoted. If the user does not have permission to change the power level of the target, an error will be thrown.

  Parameters

  • userId: string

    The user ID to change the role of.
  • role: TreePermissions

    The role to assign.

  Returns Promise<void>

  Promise which resolves when complete.