Skip to content

Commit

Permalink
fix(MeetingsAdapter): document getMeeting must complete after leaving
Browse files Browse the repository at this point in the history
  • Loading branch information
lalli-flores committed Jan 27, 2020
1 parent a09082a commit 2261c61
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/MeetingsAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ export default class MeetingsAdapter extends WebexAdapter {
* Returns an observable that emits a Meeting object.
* Whenever there is an update to the meeting, the observable
* will emit a new updated Meeting object, if datasource permits.
* Observable must complete when the meeting is left
* (e.g. @see {@link leaveMeeting} triggers an event).
*
* @param {string} ID ID of the meeting to get.
* @returns {Observable.<Meeting>}
Expand Down Expand Up @@ -136,6 +138,7 @@ export default class MeetingsAdapter extends WebexAdapter {
* Leaving from a meeting is performed as a side-effect and this method does not
* return a value. Instead, leaving from a meeting should trigger getMeeting to
* emit a new updated Meeting object.
* Leaving a meeting should trigger @see {@link getMeeting} to be complete.
*
* @param {string} ID ID of the meeting to leave from.
* @memberof MeetingsAdapter
Expand Down

0 comments on commit 2261c61

Please sign in to comment.