Skip to main content

RootServer

RootServer: object

This type is your entry point to most of the Root server-side APIs. Root automatically creates an instance of this type and provides it for your use. You import the instance and access its properties.

Type declaration​

clients​

clients: AttachedClients

Represents the set of clients attached to your App's client side. Provides methods to discover who's attached and events to be notified of changes.

community​

community: object

Represents the community where your code is installed. Provides an API to manipulate the community (e.g., create channels or send messages) and events to notify you when things in the community change (e.g., message sent or new member joins).

community.accessRules​

accessRules: AccessRuleClient

community.channelDirectories​

channelDirectories: ChannelDirectoryClient

community.channelFiles​

channelFiles: ChannelFileClient

community.channelGroups​

channelGroups: ChannelGroupClient

community.channelMessages​

channelMessages: ChannelMessageClient

community.channels​

channels: ChannelClient

community.channelWebRtcs​

channelWebRtcs: ChannelWebRtcClient

community.communities​

communities: CommunityClient

community.communityMemberBans​

communityMemberBans: CommunityMemberBanClient

community.communityMemberInvites​

communityMemberInvites: CommunityMemberInviteClient

community.communityMemberRoles​

communityMemberRoles: CommunityMemberRoleClient

community.communityMembers​

communityMembers: CommunityMemberClient

community.communityRoles​

communityRoles: CommunityRoleClient

dataStore​

dataStore: object

This property groups together all your server-side persistence APIs. All the options store data on the server side except the logs. The messages you write to the logs will be available to community admins.

dataStore.appData​

appData: KeyValueStore

dataStore.assets​

assets: AssetClient

dataStore.config​

config: RootDatabaseConfig

dataStore.logs​

logs: object

dataStore.logs.community​

community: CommunityAppLogClient

jobScheduler​

jobScheduler: JobScheduler

A service for scheduling tasks that need to execute at future date(s). The job scheduler notifies you via an event when it's time for your job to run.

lifecycle​

lifecycle: RootAppLifecycle

Lifecycle methods for your server-side component.

memberGroups​

memberGroups: MemberGroupService

Member groups