Class MSC3089Branch

Represents a MSC3089 branch - a reference to a file (leaf) in the tree. Note that this is UNSTABLE and subject to breaking changes without notice.

Hierarchy

MSC3089Branch

Index

Constructors

Properties

client directory indexEvent

Accessors

id isActive roomId version

Methods

createNewVersion delete getFileEvent getFileInfo getName getVersionHistory isLocked setLocked setName

Constructors

constructor

new MSC3089Branch(client: MatrixClient, indexEvent: MatrixEvent, directory: MSC3089TreeSpace): MSC3089Branch
Parameters
- client: MatrixClient
- indexEvent: MatrixEvent
- directory: MSC3089TreeSpace
Returns MSC3089Branch
- Defined in src/models/MSC3089Branch.ts:31

Properties

`Private` client

client: MatrixClient

`Readonly` directory

directory: MSC3089TreeSpace

`Readonly` indexEvent

indexEvent: MatrixEvent

Accessors

id

get id(): string
The file ID.

Returns string
- Defined in src/models/MSC3089Branch.ts:42

isActive

get isActive(): boolean
Whether this branch is active/valid.

Returns boolean
- Defined in src/models/MSC3089Branch.ts:53

`Private` roomId

get roomId(): string
Returns string
- Defined in src/models/MSC3089Branch.ts:64

version

get version(): number
Version for the file, one-indexed.

Returns number
- Defined in src/models/MSC3089Branch.ts:60

Methods

createNewVersion

createNewVersion(name: string, encryptedContents: XMLHttpRequestBodyInit, info: Partial<IEncryptedFile>, additionalContent?: IContent): Promise<ISendEventResponse>
Creates a new version of this file with contents in a type that is compatible with MatrixClient.uploadContent().

Returns
Promise which resolves to the file event's sent response.
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>
- Defined in src/models/MSC3089Branch.ts:180

delete

delete(): Promise<void>
Deletes the file from the tree, including all prior edits/versions.

Returns
Promise which resolves when complete.

Returns Promise<void>
- Defined in src/models/MSC3089Branch.ts:72

getFileEvent

getFileEvent(): Promise<MatrixEvent>
Gets the event the file points to.

Returns
Promise which resolves to the file's event.

Returns Promise<MatrixEvent>
- Defined in src/models/MSC3089Branch.ts:151

getFileInfo

getFileInfo(): Promise<{
httpUrl: string;
info: IEncryptedFile;
}>
Gets information about the file needed to download it.

Returns
Information about the file.

Returns Promise<{
httpUrl: string;
info: IEncryptedFile;
}>
- Defined in src/models/MSC3089Branch.ts:134

getName

getName(): string
Gets the name for this file.

Returns
The name, or "Unnamed File" if unknown.

Returns string
- Defined in src/models/MSC3089Branch.ts:84

getVersionHistory

getVersionHistory(): Promise<MSC3089Branch[]>
Gets the file's version history, starting at this file.

Returns
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.

Returns Promise<MSC3089Branch[]>
- Defined in src/models/MSC3089Branch.ts:226

isLocked

isLocked(): boolean
Gets whether or not a file is locked.

Returns
True if locked, false otherwise.

Returns boolean
- Defined in src/models/MSC3089Branch.ts:109

setLocked

setLocked(locked: boolean): Promise<void>
Sets a file as locked or unlocked.

Returns
Promise which resolves when complete.
Parameters
- locked: boolean
  
  True to lock the file, false otherwise.
Returns Promise<void>
- Defined in src/models/MSC3089Branch.ts:118

setName

setName(name: string): Promise<void>
Sets the name for this file.

Returns
Promise which resolves when complete.
Parameters
- name: string
  
  The new name for this file.
Returns Promise<void>
- Defined in src/models/MSC3089Branch.ts:93

Generated using TypeDoc