Package com.heroiclabs.nakama.api

Interface GroupOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Group, Group.Builder
public interface GroupOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAvatarUrl()
    A URL for an avatar image.
    com.google.protobuf.ByteString
    getAvatarUrlBytes()
    A URL for an avatar image.
    Timestamp
    getCreateTime()
    The UNIX time when the group was created.
    TimestampOrBuilder
    getCreateTimeOrBuilder()
    The UNIX time when the group was created.
    String
    getCreatorId()
    The id of the user who created the group.
    com.google.protobuf.ByteString
    getCreatorIdBytes()
    The id of the user who created the group.
    String
    getDescription()
    A description for the group.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A description for the group.
    int
    getEdgeCount()
    The current count of all members in the group.
    String
    getId()
    The id of a group.
    com.google.protobuf.ByteString
    getIdBytes()
    The id of a group.
    String
    getLangTag()
    The language expected to be a tag which follows the BCP-47 spec.
    com.google.protobuf.ByteString
    getLangTagBytes()
    The language expected to be a tag which follows the BCP-47 spec.
    int
    getMaxCount()
    The maximum number of members allowed.
    String
    getMetadata()
    Additional information stored as a JSON object.
    com.google.protobuf.ByteString
    getMetadataBytes()
    Additional information stored as a JSON object.
    String
    getName()
    The unique name of the group.
    com.google.protobuf.ByteString
    getNameBytes()
    The unique name of the group.
    BoolValue
    getOpen()
    Anyone can join open groups, otherwise only admins can accept members.
    BoolValueOrBuilder
    getOpenOrBuilder()
    Anyone can join open groups, otherwise only admins can accept members.
    Timestamp
    getUpdateTime()
    The UNIX time when the group was last updated.
    TimestampOrBuilder
    getUpdateTimeOrBuilder()
    The UNIX time when the group was last updated.
    boolean
    hasCreateTime()
    The UNIX time when the group was created.
    boolean
    hasOpen()
    Anyone can join open groups, otherwise only admins can accept members.
    boolean
    hasUpdateTime()
    The UNIX time when the group was last updated.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
       The id of a group.
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       The id of a group.
      string id = 1;
      Returns:
      The bytes for id.

    • getCreatorId

      String getCreatorId()
       The id of the user who created the group.
      string creator_id = 2;
      Returns:
      The creatorId.

    • getCreatorIdBytes

      com.google.protobuf.ByteString getCreatorIdBytes()
       The id of the user who created the group.
      string creator_id = 2;
      Returns:
      The bytes for creatorId.

    • getName

      String getName()
       The unique name of the group.
      string name = 3;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The unique name of the group.
      string name = 3;
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       A description for the group.
      string description = 4;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       A description for the group.
      string description = 4;
      Returns:
      The bytes for description.

    • getLangTag

      String getLangTag()
       The language expected to be a tag which follows the BCP-47 spec.
      string lang_tag = 5;
      Returns:
      The langTag.

    • getLangTagBytes

      com.google.protobuf.ByteString getLangTagBytes()
       The language expected to be a tag which follows the BCP-47 spec.
      string lang_tag = 5;
      Returns:
      The bytes for langTag.

    • getMetadata

      String getMetadata()
       Additional information stored as a JSON object.
      string metadata = 6;
      Returns:
      The metadata.

    • getMetadataBytes

      com.google.protobuf.ByteString getMetadataBytes()
       Additional information stored as a JSON object.
      string metadata = 6;
      Returns:
      The bytes for metadata.

    • getAvatarUrl

      String getAvatarUrl()
       A URL for an avatar image.
      string avatar_url = 7;
      Returns:
      The avatarUrl.

    • getAvatarUrlBytes

      com.google.protobuf.ByteString getAvatarUrlBytes()
       A URL for an avatar image.
      string avatar_url = 7;
      Returns:
      The bytes for avatarUrl.

    • hasOpen

      boolean hasOpen()
       Anyone can join open groups, otherwise only admins can accept members.
      .google.protobuf.BoolValue open = 8;
      Returns:
      Whether the open field is set.

    • getOpen

      BoolValue getOpen()
       Anyone can join open groups, otherwise only admins can accept members.
      .google.protobuf.BoolValue open = 8;
      Returns:
      The open.

    • getOpenOrBuilder

      BoolValueOrBuilder getOpenOrBuilder()
       Anyone can join open groups, otherwise only admins can accept members.
      .google.protobuf.BoolValue open = 8;

    • getEdgeCount

      int getEdgeCount()
       The current count of all members in the group.
      int32 edge_count = 9;
      Returns:
      The edgeCount.

    • getMaxCount

      int getMaxCount()
       The maximum number of members allowed.
      int32 max_count = 10;
      Returns:
      The maxCount.

    • hasCreateTime

      boolean hasCreateTime()
       The UNIX time when the group was created.
      .google.protobuf.Timestamp create_time = 11;
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      Timestamp getCreateTime()
       The UNIX time when the group was created.
      .google.protobuf.Timestamp create_time = 11;
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      TimestampOrBuilder getCreateTimeOrBuilder()
       The UNIX time when the group was created.
      .google.protobuf.Timestamp create_time = 11;

    • hasUpdateTime

      boolean hasUpdateTime()
       The UNIX time when the group was last updated.
      .google.protobuf.Timestamp update_time = 12;
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      Timestamp getUpdateTime()
       The UNIX time when the group was last updated.
      .google.protobuf.Timestamp update_time = 12;
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      TimestampOrBuilder getUpdateTimeOrBuilder()
       The UNIX time when the group was last updated.
      .google.protobuf.Timestamp update_time = 12;