diff options
| author | Austin Hellyer <[email protected]> | 2016-11-05 15:53:39 -0700 |
|---|---|---|
| committer | Austin Hellyer <[email protected]> | 2016-11-05 15:56:21 -0700 |
| commit | 2fc2edf2d95ae2c1d81029fdc7c18da22c4f13c4 (patch) | |
| tree | 4d117dabd6e3c38f8d26b735c731ea3e294ac6c5 | |
| parent | Finalize invite-related documentation (diff) | |
| download | serenity-2fc2edf2d95ae2c1d81029fdc7c18da22c4f13c4.tar.xz serenity-2fc2edf2d95ae2c1d81029fdc7c18da22c4f13c4.zip | |
Add missing voice region fields + add docs
Add the two missing fields for voice regions (`custom` and
`deprecated`), as well as documentation for everything.
| -rw-r--r-- | definitions/structs/voice_region.yml | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/definitions/structs/voice_region.yml b/definitions/structs/voice_region.yml index 3cdad29..8019b54 100644 --- a/definitions/structs/voice_region.yml +++ b/definitions/structs/voice_region.yml @@ -1,16 +1,31 @@ --- name: VoiceRegion -description: "Information about an available voice region." +description: Information about an available voice region. fields: + - name: custom + description: > + Whether it is a custom voice region, which is used for events. + type: bool + - name: deprecated + description: > + Whether it is a deprecated voice region, which you should avoid using. + type: bool - name: id + description: The internal id of the voice region. type: string - name: name + description: A recognizable name of the location of the voice region. type: string - name: optimal - type: string + description: > + Whether the voice region is optimal for use for the current user. + type: bool - name: sample_hostname + description: An example hostname for the region. type: string - name: sample_port + description: An example port for the region. type: u64 - name: vip + description: Whether the voice regions is only for VIPs. type: bool |