diff --git a/pubnub/lib/src/dx/objects/channel_metadata.dart b/pubnub/lib/src/dx/objects/channel_metadata.dart index 12c463a..0be2170 100644 --- a/pubnub/lib/src/dx/objects/channel_metadata.dart +++ b/pubnub/lib/src/dx/objects/channel_metadata.dart @@ -17,6 +17,18 @@ class ChannelMetadata { /// To include `uuid` metadata fields of channel's memebrs in response, set [includeUUIDFields] to `true` /// To include `custom` fields of channel member's uuidMetadata, set [includeUUIDCustomFields] to `true` /// + /// To omit `status` field from member metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from member metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of UUID metadata, set [includeUUIDStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of UUID metadata, set [includeUUIDType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// @@ -69,6 +81,18 @@ class ChannelMetadata { /// To include `uuid` metadata fields of channel's memebrs in response, set [includeUUIDFields] to `true` /// To include `custom` fields of channel member's uuidMetadata, set [includeUUIDCustomFields] to `true` /// + /// To omit `status` field from member metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from member metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of UUID metadata, set [includeUUIDStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of UUID metadata, set [includeUUIDType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// diff --git a/pubnub/lib/src/dx/objects/objects.dart b/pubnub/lib/src/dx/objects/objects.dart index e795662..8af921e 100644 --- a/pubnub/lib/src/dx/objects/objects.dart +++ b/pubnub/lib/src/dx/objects/objects.dart @@ -29,6 +29,12 @@ class ObjectsDx { /// To include `custom` property fields in response, set [includeCustomFields] to `true` /// Omit this parameter if you don't want to retrieve additional metadata. /// + /// To omit `status` field from metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from metadata, set [includeType] to `false` + /// Default is `true`. + /// /// You can limit number of returned user object using [limit] parameter /// Default is 100, which is also the maximum value. /// @@ -90,6 +96,12 @@ class ObjectsDx { /// To include `custom` property fields in response, set [includeCustomFields] to `true` /// Omit this parameter if you don't want to retrieve additional metadata. /// + /// To omit `status` field from metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from metadata, set [includeType] to `false` + /// Default is `true`. + /// /// `uuid` is Unique identifier of an end-user. It may contain up to 92 UTF-8 byte sequences. /// Prohibited characters are ,, /, \, *, :, channel, non-printable ASCII control characters, and Unicode zero. /// * If `uuid` not provided then it picks `uuid` from `keyset` or PubNub instance's `uuid` @@ -135,6 +147,12 @@ class ObjectsDx { /// To include `custom` property fields in response, set [includeCustomFields] to `true` /// Omit this parameter if you don't want to retrieve additional metadata. /// + /// To omit `status` field from metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from metadata, set [includeType] to `false` + /// Default is `true`. + /// /// `uuid` is Unique identifier of an end-user. It may contain up to 92 UTF-8 byte sequences. /// Prohibited characters are ,, /, \, *, :, channel, non-printable ASCII control characters, and Unicode zero. /// * If `uuid` parameter is provied then it sets metadata for given uuid. @@ -209,6 +227,12 @@ class ObjectsDx { /// To omit `totalCount` field from paginated list, set [includeCount] to `false` /// Default is `true`. /// + /// To omit `status` field from metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from metadata, set [includeType] to `false` + /// Default is `true`. + /// /// [filter] is Expression used to filter the results. /// Only objects whose properties satisfy the given expression are returned. /// @@ -263,6 +287,12 @@ class ObjectsDx { /// To include `custom` property fields in response, set [includeCustomFields] to `true` /// Omit this parameter if you don't want to retrieve additional metadata. /// + /// To omit `status` field from metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from metadata, set [includeType] to `false` + /// Default is `true`. + /// /// `channelId` is Channel identifier. Must not be empty, and may contain up to 92 UTF-8 byte sequences. /// Prohibited characters are ,, /, \, *, :, channel, non-printable ASCII control characters, and Unicode zero. Future getChannelMetadata( @@ -306,6 +336,12 @@ class ObjectsDx { /// * If you set the "custom" property, you must completely replace it; partial updates are not supported. /// * The custom object can only contain scalar values. /// + /// To omit `status` field from metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from metadata, set [includeType] to `false` + /// Default is `true`. + /// /// To include `custom` property fields in response, set [includeCustomFields] to `true` /// Omit this parameter if you don't want to retrieve additional metadata. Future setChannelMetadata( @@ -385,6 +421,18 @@ class ObjectsDx { /// Provide [start] and [end] for Previously-returned cursor bookmark for /// fetching the next/previous page. /// + /// To omit `status` field from membership metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from membership metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of channel metadata, set [includeChannelStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of channel metadata, set [includeChannelType] to `true` + /// Default is `false`. + /// /// To omit `totalCount` field from paginated list, set [includeCount] to `false` /// Default is `true`. /// @@ -471,6 +519,18 @@ class ObjectsDx { /// To include `channel` metadata fields of uuid's membership in response, set [includeChannelFields] to `true` /// To include `custom` fields of membership's channelmetadata, set [includeChannelCustomFields] to `true` /// + /// To omit `status` field from membership metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from membership metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of channel metadata, set [includeChannelStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of channel metadata, set [includeChannelType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// @@ -574,6 +634,18 @@ class ObjectsDx { /// To include `channel` metadata fields of uuid's membership in response, set [includeChannelFields] to `true` /// To include `custom` fields of membership's channel metadata, set [includeChannelCustomFields] to `true` /// + /// To omit `status` field from membership metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from membership metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of channel metadata, set [includeChannelStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of channel metadata, set [includeChannelType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// @@ -665,6 +737,18 @@ class ObjectsDx { /// To include `channel` metadata fields of uuid's membership in response, set [includeChannelFields] to `true` /// To include `custom` fields of membership's channel metadata, set [includeChannelCustomFields] to `true` /// + /// To omit `status` field from membership metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from membership metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of channel metadata, set [includeChannelStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of channel metadata, set [includeChannelType] to `true` + /// Default is `false`. + /// /// * If `uuid` not provided then it picks `uuid` from given `keyset` or PubNub instance's `uuid` /// * If no `uuid` is set in PubNub instance default keyset, `keyset` does not hold uuid /// and `uuid`not provided in argument then it throws InvariantException @@ -759,6 +843,18 @@ class ObjectsDx { /// To include `uuid` metadata fields of channel's memebrs in response, set [includeUUIDFields] to `true` /// To include `custom` fields of channel member's uuidMetadata, set [includeUUIDCustomFields] to `true` /// + /// To omit `status` field from member metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from member metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of UUID metadata, set [includeUUIDStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of UUID metadata, set [includeUUIDType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// @@ -844,6 +940,18 @@ class ObjectsDx { /// To include `uuid` metadata fields of channel's memebrs in response, set [includeUUIDFields] to `true` /// To include `custom` fields of channel member's uuidMetadata, set [includeUUIDCustomFields] to `true` /// + /// To omit `status` field from member metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from member metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of UUID metadata, set [includeUUIDStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of UUID metadata, set [includeUUIDType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// @@ -939,6 +1047,18 @@ class ObjectsDx { /// To include `uuid` metadata fields of channel's memebrs in response, set [includeUUIDFields] to `true` /// To include `custom` fields of channel member's uuidMetadata, set [includeUUIDCustomFields] to `true` /// + /// To omit `status` field from member metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from member metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of UUID metadata, set [includeUUIDStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of UUID metadata, set [includeUUIDType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// @@ -1029,6 +1149,18 @@ class ObjectsDx { /// To include `uuid` metadata fields of channel's memebrs in response, set [includeUUIDFields] to `true` /// To include `custom` fields of channel member's uuidMetadata, set [includeUUIDCustomFields] to `true` /// + /// To omit `status` field from member metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from member metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of UUID metadata, set [includeUUIDStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of UUID metadata, set [includeUUIDType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// diff --git a/pubnub/lib/src/dx/objects/uuid_metadata.dart b/pubnub/lib/src/dx/objects/uuid_metadata.dart index 1808ca2..69a7c0b 100644 --- a/pubnub/lib/src/dx/objects/uuid_metadata.dart +++ b/pubnub/lib/src/dx/objects/uuid_metadata.dart @@ -16,6 +16,18 @@ class UUIDMetadata { /// To include `channel` metadata fields of uuid's membership in response, set [includeChannelFields] to `true` /// To include `custom` fields of membership's channel metadata, set [includeChannelCustomFields] to `true` /// + /// To omit `status` field from membership metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from membership metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of channel metadata, set [includeChannelStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of channel metadata, set [includeChannelType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. /// @@ -69,6 +81,18 @@ class UUIDMetadata { /// To include `channel` metadata fields of uuid's membership in response, set [includeChannelFields] to `true` /// To include `custom` fields of membership's channel metadata, set [includeChannelCustomFields] to `true` /// + /// To omit `status` field from membership metadata, set [includeStatus] to `false` + /// Default is `true`. + /// + /// To omit `type` field from membership metadata, set [includeType] to `false` + /// Default is `true`. + /// + /// To get `status` field of channel metadata, set [includeChannelStatus] to `true` + /// Default is `false`. + /// + /// To omit `type` field of channel metadata, set [includeChannelType] to `true` + /// Default is `false`. + /// /// Use [limit] to specify Number of objects to return in response. /// Default is 100, which is also the maximum value. ///