Class MSC3089Branch

constructor

• new MSC3089Branch(
      client: MatrixClient,
      indexEvent: MatrixEvent,
      directory: MSC3089TreeSpace,
  ): MSC3089Branch

  Parameters

  • client: MatrixClient
  • indexEvent: MatrixEvent
  • directory: MSC3089TreeSpace

  Returns MSC3089Branch

Readonlydirectory

ReadonlyindexEvent

id

• get id(): string

  The file ID.

  Returns string

isActive

• get isActive(): boolean

  Whether this branch is active/valid.

  Returns boolean

version

• get version(): number

  Version for the file, one-indexed.

  Returns number

createNewVersion

• createNewVersion(
      name: string,
      encryptedContents: XMLHttpRequestBodyInit,
      info: EncryptedFile,
      additionalContent?: IContent,
  ): Promise<ISendEventResponse>

  Creates a new version of this file with contents in a type that is compatible with MatrixClient.uploadContent().

  Parameters

  • name: string

    The name of the file.
  • encryptedContents: XMLHttpRequestBodyInit

    The encrypted contents.
  • info: EncryptedFile

    The encrypted file information.
  • OptionaladditionalContent: 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 file from the tree, including all prior edits/versions.

  Returns Promise<void>

  Promise which resolves when complete.

getFileEvent

• getFileEvent(): Promise<MatrixEvent>

  Gets the event the file points to.

  Returns Promise<MatrixEvent>

  Promise which resolves to the file's event.

getFileInfo

• getFileInfo(): Promise<{ httpUrl: string; info: EncryptedFile }>

  Gets information about the file needed to download it.

  Returns Promise<{ httpUrl: string; info: EncryptedFile }>

  Information about the file.

getName

• getName(): string

  Gets the name for this file.

  Returns string

  The name, or "Unnamed File" if unknown.

getVersionHistory

• getVersionHistory(): Promise<MSC3089Branch[]>

  Gets the file's version history, starting at this file.

  Returns Promise<MSC3089Branch[]>

  Promise which resolves to the file's version history, with the first element being the current version and the last element being the first version.

isLocked

• isLocked(): boolean

  Gets whether or not a file is locked.

  Returns boolean

  True if locked, false otherwise.

setLocked

• setLocked(locked: boolean): Promise<void>

  Sets a file as locked or unlocked.

  Parameters

  • locked: boolean

    True to lock the file, false otherwise.

  Returns Promise<void>

  Promise which resolves when complete.

setName

• setName(name: string): Promise<void>

  Sets the name for this file.

  Parameters

  • name: string

    The new name for this file.

  Returns Promise<void>

  Promise which resolves when complete.