Documentation update

DolbyIO · Mar 13, 2023 · b04d602 · b04d602
1 parent cd0beca
commit b04d602
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 0 deletions.
diff --git a/docs/classes/internal.NotificationService.md b/docs/classes/internal.NotificationService.md
@@ -12,6 +12,8 @@ The NotificationService allows inviting participants to a conference.
 
 ### Methods
 
+- [subscribe](internal.NotificationService.md#subscribe)
+- [unsubscribe](internal.NotificationService.md#unsubscribe)
 - [decline](internal.NotificationService.md#decline)
 - [invite](internal.NotificationService.md#invite)
 - [onInvitationReceived](internal.NotificationService.md#oninvitationreceived)
@@ -24,6 +26,42 @@ The NotificationService allows inviting participants to a conference.
 
 ## Methods
 
+### subscribe
+
+▸ **subscribe**(`events`): `Promise`<`void`\>
+
+Subscribes to the specified notifications.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `events` | [`Subscription`](../interfaces/internal.Subscription.md)[] | An array of the subscribed subscription types. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+___
+
+### unsubscribe
+
+▸ **unsubscribe**(`events`): `Promise`<`void`\>
+
+Unsubscribes from the specified notifications.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `events` | [`Subscription`](../interfaces/internal.Subscription.md)[] | An array of the subscribed subscription types. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+___
+
 ### decline
 
 ▸ **decline**(`conference`): `Promise`<`void`\>

diff --git a/docs/interfaces/internal.Subscription.md b/docs/interfaces/internal.Subscription.md
@@ -0,0 +1,28 @@
+# Interface: Subscription
+
+[internal](../modules/internal.md).Subscription
+
+The Subscription model is an interface for all subscription types.
+
+## Table of contents
+
+### Properties
+
+- [type](internal.Subscription.md#type)
+- [conferenceAlias](internal.Subscription.md#conferencealias)
+
+## Properties
+
+### type
+
+• **type**: `string`
+
+The subscription type.
+
+___
+
+### conferenceAlias
+
+• **conferenceAlias**: `string`
+
+The conference alias.
diff --git a/docs/modules/internal.md b/docs/modules/internal.md
@@ -69,6 +69,7 @@
 - [FileConverted](../interfaces/internal.FileConverted.md)
 - [FilePresentation](../interfaces/internal.FilePresentation.md)
 - [InvitationReceivedEventType](../interfaces/internal.InvitationReceivedEventType.md)
+- [Subscription](../interfaces/internal.Subscription.md)
 - [RecordingStatusUpdatedEventType](../interfaces/internal.RecordingStatusUpdatedEventType.md)
 - [Recording](../interfaces/internal.Recording.md)
 - [VideoPresentationEventType](../interfaces/internal.VideoPresentationEventType.md)