plugnmeet-sdk-js 2.1.2 → 2.1.3-1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1 -212
- package/dist/index.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,216 +1,5 @@
|
|
|
1
|
-
import { CreateRoomReq, CreateRoomRes, GenerateTokenReq, GenerateTokenRes, IsRoomActiveReq, IsRoomActiveRes, GetActiveRoomInfoReq, GetActiveRoomInfoRes, GetActiveRoomsInfoRes, FetchPastRoomsReq, FetchPastRoomsRes, RoomEndReq, RoomEndRes, FetchArtifactsReq, FetchArtifactsRes, DeleteArtifactReq, DeleteArtifactRes, GetArtifactDownloadTokenReq, GetArtifactDownloadTokenRes, ArtifactInfoReq, ArtifactInfoRes, FetchRecordingsReq, FetchRecordingsRes, DeleteRecordingReq, DeleteRecordingRes, GetDownloadTokenReq, GetDownloadTokenRes, RecordingInfoReq, RecordingInfoRes, UpdateRecordingMetadataReq, UpdateRecordingMetadataRes, GetClientFilesRes } from "plugnmeet-protocol-js";
|
|
2
|
-
interface PlugNmeetAPI {
|
|
3
|
-
/**
|
|
4
|
-
* Create new room
|
|
5
|
-
* @returns Promise<CreateRoomRes>
|
|
6
|
-
* @param params
|
|
7
|
-
*/
|
|
8
|
-
createRoom(params: CreateRoomReq): Promise<CreateRoomRes>;
|
|
9
|
-
/**
|
|
10
|
-
* Generate join token
|
|
11
|
-
* @param params
|
|
12
|
-
* @returns Promise<GenerateTokenRes>
|
|
13
|
-
*/
|
|
14
|
-
getJoinToken(params: GenerateTokenReq): Promise<GenerateTokenRes>;
|
|
15
|
-
/**
|
|
16
|
-
* If room is active or not
|
|
17
|
-
* @param params
|
|
18
|
-
* @returns Promise<IsRoomActiveRes>
|
|
19
|
-
*/
|
|
20
|
-
isRoomActive(params: IsRoomActiveReq): Promise<IsRoomActiveRes>;
|
|
21
|
-
/**
|
|
22
|
-
* Get active room information
|
|
23
|
-
* @param params
|
|
24
|
-
* @returns Promise<GetActiveRoomInfoRes>
|
|
25
|
-
*/
|
|
26
|
-
getActiveRoomInfo(params: GetActiveRoomInfoReq): Promise<GetActiveRoomInfoRes>;
|
|
27
|
-
/**
|
|
28
|
-
* Get all active rooms
|
|
29
|
-
* @returns Promise<GetActiveRoomsInfoRes>
|
|
30
|
-
*/
|
|
31
|
-
getActiveRoomsInfo(): Promise<GetActiveRoomsInfoRes>;
|
|
32
|
-
/**
|
|
33
|
-
* Fetch info about past rooms
|
|
34
|
-
* @param params
|
|
35
|
-
* @returns Promise<FetchPastRoomsRes>
|
|
36
|
-
*/
|
|
37
|
-
fetchPastRoomsInfo(params: FetchPastRoomsReq): Promise<FetchPastRoomsRes>;
|
|
38
|
-
/**
|
|
39
|
-
* End active room
|
|
40
|
-
* @param params
|
|
41
|
-
* @returns Promise<RoomEndRes>
|
|
42
|
-
*/
|
|
43
|
-
endRoom(params: RoomEndReq): Promise<RoomEndRes>;
|
|
44
|
-
/**
|
|
45
|
-
* Fetch artifacts
|
|
46
|
-
* @param params
|
|
47
|
-
* @returns Promise<FetchArtifactsRes>
|
|
48
|
-
*/
|
|
49
|
-
fetchArtifacts(params: FetchArtifactsReq): Promise<FetchArtifactsRes>;
|
|
50
|
-
/**
|
|
51
|
-
* Delete artifact
|
|
52
|
-
* @param params
|
|
53
|
-
* @returns Promise<DeleteArtifactRes>
|
|
54
|
-
*/
|
|
55
|
-
deleteArtifact(params: DeleteArtifactReq): Promise<DeleteArtifactRes>;
|
|
56
|
-
/**
|
|
57
|
-
* Generate token to download Artifact
|
|
58
|
-
* @param params
|
|
59
|
-
* @returns Promise<AnalyticsDownloadTokenResponse>
|
|
60
|
-
*/
|
|
61
|
-
getArtifactDownloadToken(params: GetArtifactDownloadTokenReq): Promise<GetArtifactDownloadTokenRes>;
|
|
62
|
-
/**
|
|
63
|
-
* Get Artifact details
|
|
64
|
-
* @param params
|
|
65
|
-
* @returns Promise<ArtifactInfoRes>
|
|
66
|
-
*/
|
|
67
|
-
getArtifactInfo(params: ArtifactInfoReq): Promise<ArtifactInfoRes>;
|
|
68
|
-
/**
|
|
69
|
-
* Fetch recordings
|
|
70
|
-
* @param params
|
|
71
|
-
* @returns Promise<FetchRecordingsRes>
|
|
72
|
-
*/
|
|
73
|
-
fetchRecordings(params: FetchRecordingsReq): Promise<FetchRecordingsRes>;
|
|
74
|
-
/**
|
|
75
|
-
* Delete recording
|
|
76
|
-
* @param params
|
|
77
|
-
* @returns Promise<DeleteRecordingRes>
|
|
78
|
-
*/
|
|
79
|
-
deleteRecordings(params: DeleteRecordingReq): Promise<DeleteRecordingRes>;
|
|
80
|
-
/**
|
|
81
|
-
* Generate token to download recording
|
|
82
|
-
* @param params
|
|
83
|
-
* @returns Promise<GetDownloadTokenRes>
|
|
84
|
-
*/
|
|
85
|
-
getRecordingDownloadToken(params: GetDownloadTokenReq): Promise<GetDownloadTokenRes>;
|
|
86
|
-
/**
|
|
87
|
-
* Update recording metadata info
|
|
88
|
-
* @param params
|
|
89
|
-
* @returns Promise<UpdateRecordingMetadataRes>
|
|
90
|
-
*/
|
|
91
|
-
updateRecordingMetadata(params: UpdateRecordingMetadataReq): Promise<UpdateRecordingMetadataRes>;
|
|
92
|
-
/**
|
|
93
|
-
* Get recording details
|
|
94
|
-
* @param params
|
|
95
|
-
* @returns Promise<RecordingInfoRes>
|
|
96
|
-
*/
|
|
97
|
-
getRecordingInfo(params: RecordingInfoReq): Promise<RecordingInfoRes>;
|
|
98
|
-
/**
|
|
99
|
-
* To get JS & CSS files to build interface
|
|
100
|
-
* @returns Promise<GetClientFilesRes>
|
|
101
|
-
*/
|
|
102
|
-
getClientFiles(): Promise<GetClientFilesRes>;
|
|
103
|
-
}
|
|
104
|
-
export class PlugNmeet implements PlugNmeetAPI {
|
|
105
|
-
protected defaultPath: string;
|
|
106
|
-
/**
|
|
107
|
-
* @param serverUrl plugNmeet server URL
|
|
108
|
-
* @param apiKey plugNmeet API_Key
|
|
109
|
-
* @param apiSecret plugNmeet API_Secret
|
|
110
|
-
*/
|
|
111
|
-
constructor(serverUrl: string, apiKey: string, apiSecret: string);
|
|
112
|
-
/**
|
|
113
|
-
* Create new room
|
|
114
|
-
* @param params
|
|
115
|
-
* @returns Promise<CreateRoomRes>
|
|
116
|
-
*/
|
|
117
|
-
createRoom(params: CreateRoomReq): Promise<CreateRoomRes>;
|
|
118
|
-
/**
|
|
119
|
-
* Generate join token
|
|
120
|
-
* @param params
|
|
121
|
-
* @returns Promise<GenerateTokenRes>
|
|
122
|
-
*/
|
|
123
|
-
getJoinToken(params: GenerateTokenReq): Promise<GenerateTokenRes>;
|
|
124
|
-
/**
|
|
125
|
-
* If room is active or not
|
|
126
|
-
* @param params
|
|
127
|
-
* @returns Promise<IsRoomActiveRes>
|
|
128
|
-
*/
|
|
129
|
-
isRoomActive(params: IsRoomActiveReq): Promise<IsRoomActiveRes>;
|
|
130
|
-
/**
|
|
131
|
-
* Get active room information
|
|
132
|
-
* @param params
|
|
133
|
-
* @returns Promise<GetActiveRoomInfoRes>
|
|
134
|
-
*/
|
|
135
|
-
getActiveRoomInfo(params: GetActiveRoomInfoReq): Promise<GetActiveRoomInfoRes>;
|
|
136
|
-
/**
|
|
137
|
-
* Get all active rooms
|
|
138
|
-
* @returns Promise<GetActiveRoomsInfoRes>
|
|
139
|
-
*/
|
|
140
|
-
getActiveRoomsInfo(): Promise<GetActiveRoomsInfoRes>;
|
|
141
|
-
/**
|
|
142
|
-
* Fetch info about past rooms
|
|
143
|
-
* @param params
|
|
144
|
-
* @returns Promise<FetchPastRoomsRes>
|
|
145
|
-
*/
|
|
146
|
-
fetchPastRoomsInfo(params: FetchPastRoomsReq): Promise<FetchPastRoomsRes>;
|
|
147
|
-
/**
|
|
148
|
-
* End active room
|
|
149
|
-
* @param params
|
|
150
|
-
* @returns Promise<RoomEndRes>
|
|
151
|
-
*/
|
|
152
|
-
endRoom(params: RoomEndReq): Promise<RoomEndRes>;
|
|
153
|
-
/**
|
|
154
|
-
* Fetch artifacts
|
|
155
|
-
* @param params
|
|
156
|
-
* @returns Promise<FetchArtifactsRes>
|
|
157
|
-
*/
|
|
158
|
-
fetchArtifacts(params: FetchArtifactsReq): Promise<FetchArtifactsRes>;
|
|
159
|
-
/**
|
|
160
|
-
* Delete artifact
|
|
161
|
-
* @param params
|
|
162
|
-
* @returns Promise<DeleteArtifactRes>
|
|
163
|
-
*/
|
|
164
|
-
deleteArtifact(params: DeleteArtifactReq): Promise<DeleteArtifactRes>;
|
|
165
|
-
/**
|
|
166
|
-
* Generate token to download Artifact
|
|
167
|
-
* @param params
|
|
168
|
-
* @returns Promise<GetArtifactDownloadTokenRes>
|
|
169
|
-
*/
|
|
170
|
-
getArtifactDownloadToken(params: GetArtifactDownloadTokenReq): Promise<GetArtifactDownloadTokenRes>;
|
|
171
|
-
/**
|
|
172
|
-
* Get Artifact details
|
|
173
|
-
* @param params
|
|
174
|
-
* @returns Promise<ArtifactInfoRes>
|
|
175
|
-
*/
|
|
176
|
-
getArtifactInfo(params: ArtifactInfoReq): Promise<ArtifactInfoRes>;
|
|
177
|
-
/**
|
|
178
|
-
* Fetch recordings
|
|
179
|
-
* @param params
|
|
180
|
-
* @returns Promise<FetchRecordingsRes>
|
|
181
|
-
*/
|
|
182
|
-
fetchRecordings(params: FetchRecordingsReq): Promise<FetchRecordingsRes>;
|
|
183
|
-
/**
|
|
184
|
-
* Delete recording
|
|
185
|
-
* @param params
|
|
186
|
-
* @returns Promise<DeleteRecordingRes>
|
|
187
|
-
*/
|
|
188
|
-
deleteRecordings(params: DeleteRecordingReq): Promise<DeleteRecordingRes>;
|
|
189
|
-
/**
|
|
190
|
-
* Generate token to download recording
|
|
191
|
-
* @param params
|
|
192
|
-
* @returns Promise<GetDownloadTokenRes>
|
|
193
|
-
*/
|
|
194
|
-
getRecordingDownloadToken(params: GetDownloadTokenReq): Promise<GetDownloadTokenRes>;
|
|
195
|
-
/**
|
|
196
|
-
* Update recording metadata info
|
|
197
|
-
* @param params
|
|
198
|
-
* @returns Promise<UpdateRecordingMetadataRes>
|
|
199
|
-
*/
|
|
200
|
-
updateRecordingMetadata(params: UpdateRecordingMetadataReq): Promise<UpdateRecordingMetadataRes>;
|
|
201
|
-
/**
|
|
202
|
-
* Get recording details
|
|
203
|
-
* @param params
|
|
204
|
-
* @returns Promise<RecordingInfoRes>
|
|
205
|
-
*/
|
|
206
|
-
getRecordingInfo(params: RecordingInfoReq): Promise<RecordingInfoRes>;
|
|
207
|
-
/**
|
|
208
|
-
* To get JS & CSS files to build interface
|
|
209
|
-
* @returns Promise<GetClientFilesRes>
|
|
210
|
-
*/
|
|
211
|
-
getClientFiles(): Promise<GetClientFilesRes>;
|
|
212
|
-
}
|
|
213
1
|
export { create as createRequest } from '@bufbuild/protobuf';
|
|
214
2
|
export * from 'plugnmeet-protocol-js';
|
|
3
|
+
export { PlugNmeet } from './PlugNmeet';
|
|
215
4
|
|
|
216
5
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"
|
|
1
|
+
{"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC7D,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC","sources":["src/src/index.ts","src/index.ts"],"sourcesContent":[null,"export { create as createRequest } from '@bufbuild/protobuf';\nexport * from 'plugnmeet-protocol-js';\n\nexport { PlugNmeet } from './PlugNmeet';\n"],"names":[],"version":3,"file":"index.d.ts.map"}
|