Interface IModifyCreator

Hierarchy

IModifyCreator

Index

Methods

Methods

finish

finish(builder: IDiscussionBuilder | IRoomBuilder | ILivechatMessageBuilder | IMessageBuilder | IVideoConferenceBuilder | IUserBuilder): Promise<string>

- Defined in src/definition/accessors/IModifyCreator.ts:93
Finishes the creating process, saving the object to the database.

Parameters
- builder: IDiscussionBuilder | IRoomBuilder | ILivechatMessageBuilder | IMessageBuilder | IVideoConferenceBuilder | IUserBuilder
  
  the builder instance
Returns Promise<string>

the resulting id of the resulting object

getBlockBuilder

getBlockBuilder(): BlockBuilder

- Defined in src/definition/accessors/IModifyCreator.ts:33
deprecated

please prefer the rocket.chat/ui-kit components

Gets a new instance of a BlockBuilder

Returns BlockBuilder

getLivechatCreator

getLivechatCreator(): ILivechatCreator

- Defined in src/definition/accessors/IModifyCreator.ts:21
Get the creator object responsible for the Livechat integrations

Returns ILivechatCreator

getUploadCreator

getUploadCreator(): IUploadCreator

- Defined in src/definition/accessors/IModifyCreator.ts:26
Get the creator object responsible for the upload.

Returns IUploadCreator

startBotUser

startBotUser(data?: Partial<IBotUser>): IUserBuilder

- Defined in src/definition/accessors/IModifyCreator.ts:85
Starts the process for building a new bot user.

Parameters
- Optional data: Partial<IBotUser>
  
  (optional) the initial data to pass into the builder, the id property will be ignored
Returns IUserBuilder

an IUserBuilder instance

startDiscussion

startDiscussion(data?: Partial<IRoom>): IDiscussionBuilder

- Defined in src/definition/accessors/IModifyCreator.ts:68
Starts the process for building a new discussion.

Parameters
- Optional data: Partial<IRoom>
  
  (optional) the initial data to pass into the builder, the id property will be ignored
Returns IDiscussionBuilder

an IDiscussionBuilder instance

startLivechatMessage

startLivechatMessage(data?: ILivechatMessage): ILivechatMessageBuilder

- Defined in src/definition/accessors/IModifyCreator.ts:50
Starts the process for building a new livechat message object.

Parameters
- Optional data: ILivechatMessage
  
  (optional) the initial data to pass into the builder, the id property will be ignored
Returns ILivechatMessageBuilder

an IMessageBuilder instance

startMessage

startMessage(data?: IMessage): IMessageBuilder

- Defined in src/definition/accessors/IModifyCreator.ts:41
Starts the process for building a new message object.

Parameters
- Optional data: IMessage
  
  (optional) the initial data to pass into the builder, the id property will be ignored
Returns IMessageBuilder

an IMessageBuilder instance

startRoom

startRoom(data?: IRoom): IRoomBuilder

- Defined in src/definition/accessors/IModifyCreator.ts:59
Starts the process for building a new room.

Parameters
- Optional data: IRoom
  
  (optional) the initial data to pass into the builder, the id property will be ignored
Returns IRoomBuilder

an IRoomBuilder instance

startVideoConference

startVideoConference(data?: Partial<AppVideoConference>): IVideoConferenceBuilder

- Defined in src/definition/accessors/IModifyCreator.ts:76
Starts the process for building a new video conference.

Parameters
- Optional data: Partial<AppVideoConference>
  
  (optional) the initial data to pass into the builder,
Returns IVideoConferenceBuilder

an IVideoConferenceBuilder instance

Generated using TypeDoc