Class: ActivityEndpoint ​
Defined in: endpoints/activity.ts:20
Activities: the instance's catalog of web apps a call can open together, and the one open in a call.
Everyone signed in can list the catalog; instance admins add, change and remove its entries, and see the activities packaged with Refract. Starting, joining and leaving are for people in the call; ending one is for whoever started it, or someone who may move members in that channel.
Constructors ​
Constructor ​
ts
new ActivityEndpoint(client): ActivityEndpoint;Defined in: endpoints/activity.ts:21
Parameters ​
| Parameter | Type |
|---|---|
client | RESTClient |
Returns ​
ActivityEndpoint
Methods ​
create() ​
ts
create(activity): Promise<IActivityResponse>;Defined in: endpoints/activity.ts:32
Parameters ​
| Parameter | Type |
|---|---|
activity | IActivityInput |
Returns ​
Promise<IActivityResponse>
end() ​
ts
end(channelId): Promise<IActivitySessionResponse>;Defined in: endpoints/activity.ts:63
Parameters ​
| Parameter | Type |
|---|---|
channelId | number |
Returns ​
Promise<IActivitySessionResponse>
getSession() ​
ts
getSession(channelId): Promise<IActivitySessionResponse>;Defined in: endpoints/activity.ts:54
what is open in a call's channel, if anything
Parameters ​
| Parameter | Type |
|---|---|
channelId | number |
Returns ​
Promise<IActivitySessionResponse>
join() ​
ts
join(channelId): Promise<IActivitySessionResponse>;Defined in: endpoints/activity.ts:67
Parameters ​
| Parameter | Type |
|---|---|
channelId | number |
Returns ​
Promise<IActivitySessionResponse>
leave() ​
ts
leave(channelId): Promise<IActivitySessionResponse>;Defined in: endpoints/activity.ts:72
close it for yourself; it ends when the last person leaves
Parameters ​
| Parameter | Type |
|---|---|
channelId | number |
Returns ​
Promise<IActivitySessionResponse>
list() ​
ts
list(): Promise<IActivitiesResponse>;Defined in: endpoints/activity.ts:23
Returns ​
Promise<IActivitiesResponse>
packaged() ​
ts
packaged(): Promise<IPackagedActivitiesResponse>;Defined in: endpoints/activity.ts:28
the activities packaged with Refract that this instance serves; install one with create() and its url
Returns ​
Promise<IPackagedActivitiesResponse>
refresh() ​
ts
refresh(activityId): Promise<IActivityResponse>;Defined in: endpoints/activity.ts:49
after its page changed (a push to its GitHub Pages repository, say): every copy open in a call loads it again, and everyone gets the latest files past their caches. Instance admins only.
Parameters ​
| Parameter | Type |
|---|---|
activityId | number |
Returns ​
Promise<IActivityResponse>
remove() ​
ts
remove(activityId): Promise<IApiResponse>;Defined in: endpoints/activity.ts:40
Parameters ​
| Parameter | Type |
|---|---|
activityId | number |
Returns ​
Promise<IApiResponse>
start() ​
ts
start(channelId, activityId): Promise<IActivitySessionResponse>;Defined in: endpoints/activity.ts:59
open an activity in the call you are in, replacing any open one you may end; you join it
Parameters ​
| Parameter | Type |
|---|---|
channelId | number |
activityId | number |
Returns ​
Promise<IActivitySessionResponse>
update() ​
ts
update(activityId, changes): Promise<IActivityResponse>;Defined in: endpoints/activity.ts:36
Parameters ​
| Parameter | Type |
|---|---|
activityId | number |
changes | Partial<IActivityInput> |
Returns ​
Promise<IActivityResponse>