ObjectsDx class Objects

Groups objects methods together.

Available as PubNub.objects. Introduced with Objects API.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getAllChannelMetadata({int? limit, String? start, String? end, bool? includeCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<GetAllChannelMetadataResult>

Returns a paginated list of all channelMetadata associated with the given subscription key, optionally including each channelMetadata record's custom data object.

getAllUUIDMetadata({bool? includeCustomFields, int? limit, String? start, String? end, bool includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<GetAllUuidMetadataResult>

Returns a paginated list of all uuidMetadata associated with the given subscription key, optionally including each uuidMetadata record's custom data object.

getChannelMembers(String channelId, {int? limit, String? start, String? end, bool? includeCustomFields, bool? includeUUIDFields, bool? includeUUIDCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<ChannelMembersResult>

Returns the members' metadata in the specified channel channelId, optionally including the custom data objects for: the channel's perspective on their members set ("custom"), the channel's perspective of the member ("uuid"), and the uuid's custom data ("uuid.custom").

getChannelMetadata(String channelId, {Keyset? keyset, String? using, bool? includeCustomFields}) → Future<GetChannelMetadataResult>

Returns the specified channelMetadata, optionally including channelMetadata's custom data object.

getMemberships({String? uuid, int? limit, String? start, String? end, bool? includeCustomFields, bool? includeChannelFields, bool? includeChannelCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<MembershipsResult>

Returns the specified uuid channel memberships, optionally including the custom data objects for: the uuid's perspective on their membership set ("custom"), the uuid's perspective on the channel ("channel"), and the channel's custom data ("channel.custom").

getUUIDMetadata({String? uuid, Keyset? keyset, String? using, bool? includeCustomFields}) → Future<GetUuidMetadataResult>

Returns the specified uuidMetadata, optionally including uuidMetadata's custom data object.

manageChannelMembers(String channelId, List<ChannelMemberMetadataInput> setMetadata, Set<String> removeMemberUuids, {int? limit, String? start, String? end, bool? includeCustomFields, bool? includeUUIDFields, bool? includeUUIDCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<ChannelMembersResult>

Sets the members's metadata in the specified channel channelId and/or deletes members uuids metadata it returns members paginated list optionally including the custom data objects for: the channel's perspective on their members set ("custom"), the channel's perspective of the member ("uuid"), and the uuid's custom data ("uuid.custom").

manageMemberships(List<MembershipMetadataInput> setMetadata, Set<String> removeChannelIds, {String? uuid, int? limit, String? start, String? end, bool? includeCustomFields, bool? includeChannelFields, bool? includeChannelCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<MembershipsResult>

Sets channel membership metadata and/or deletes memberships metadata for the specified uuid. setMetadata is memberships metadata input to provide metadata details It deletes uuid's membership from given removeChannelIds channels

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeChannelMembers(String channelId, Set<String> uuids, {int? limit, String? start, String? end, bool? includeCustomFields, bool? includeUUIDFields, bool? includeUUIDCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<ChannelMembersResult>

Removes channel members uuids from the specified channel channelId and returns remaining members paginated list optionally including the custom data objects for: the channel's perspective on their members set ("custom"), the channel's perspective of the member ("uuid"), and the uuid's custom data ("uuid.custom").

removeChannelMetadata(String channelId, {Keyset? keyset, String? using}) → Future<RemoveChannelMetadataResult>

Deletes metadata for the specified channel channelId from the database. 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.

removeMemberships(Set<String> channelIds, {String? uuid, int? limit, String? start, String? end, bool? includeCustomFields, bool? includeChannelFields, bool? includeChannelCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<MembershipsResult>

Deletes memberships metadata for the specified uuid. channelIds is set of channelIds from which specified uuid's membership metadata removed

removeUUIDMetadata({String? uuid, Keyset? keyset, String? using}) → Future<RemoveUuidMetadataResult>

Deletes the specified uuid's metadata form the database. If uuid is provied then it deletes metadata for given uuid. In case of null uuid it deletes metadata for 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

setChannelMembers(String channelId, List<ChannelMemberMetadataInput> setMetadata, {int? limit, String? start, String? end, bool? includeCustomFields, bool? includeUUIDFields, bool? includeUUIDCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<ChannelMembersResult>

Sets the members's metadata in the specified channel and returns members paginated list optionally including the custom data objects for: the channel's perspective on their members set ("custom"), the channel's perspective of the member ("uuid"), and the uuid's custom data ("uuid.custom").

setChannelMetadata(String channelId, ChannelMetadataInput channelMetadataInput, {bool? includeCustomFields, Keyset? keyset, String? using}) → Future<SetChannelMetadataResult>

Sets metadata for the specified channelId in the database. Returns the updated uuid object, optionally including custom properties. 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.

setMemberships(List<MembershipMetadataInput> setMetadata, {String? uuid, int? limit, String? start, String? end, bool? includeCustomFields, bool? includeChannelFields, bool? includeChannelCustomFields, bool? includeCount = true, String? filter, Set<String>? sort, Keyset? keyset, String? using}) → Future<MembershipsResult>

Sets channel membership metadata for the specified uuid. setMetadata is memberships metadata input to provide metadata details

setUUIDMetadata(UuidMetadataInput uuidMetadataInput, {String? uuid, bool? includeCustomFields, Keyset? keyset, String? using}) → Future<SetUuidMetadataResult>

Sets metadata for the specified uuid in the database. Returns the updated uuid object, optionally including custom properties.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited