Sha256: 09260b8a13e4e99643308b68ea067065a6e4e7c15d0d61c9f51a8464f3721458
Contents?: true
Size: 1.21 KB
Versions: 16
Compression:
Stored size: 1.21 KB
Contents
# Bandwidth::Subscriptions
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **session_id** | **String** | If present, and not overridden by the array of participants, it represents the session the subscriptions are associated with. If this is the only field, the subscriber will be subscribed to all participants in the session (including any participants that are later added to the session). Upon creation of a Participant, returns as an empty object. | [optional] |
| **participants** | [**Array<ParticipantSubscription>**](ParticipantSubscription.md) | (optional) A list of participants in the session that will be subscribed to. If present and not empty or null, this will override any sessionId specified in the body. Returns empty if used during the creation of a Participant. | [optional] |
## Example
```ruby
require 'bandwidth-sdk'
instance = Bandwidth::Subscriptions.new(
session_id: d8886aad-b956-4e1b-b2f4-d7c9f8162772,
participants: [{"participantId":"568749d5-04d5-483d-adf5-deac7dd3d521"},{"participantId":"0275e47f-dd21-4cf0-a1e1-dfdc719e73a7","streamAliases":["alias_1","alias_2"]}]
)
```
Version data entries
16 entries across 16 versions & 1 rubygems