Class PortalGroup

    • Method Detail

      • fromJson

        public static PortalGroup fromJson​(String json,
                                           Portal portal)
        Creates a PortalGroup instance from a JSON string.
        Parameters:
        json - a JSON string that represents a PortalGroup
        portal - the Portal object for use by the PortalGroup
        Returns:
        a PortalGroup instance
        Throws:
        IllegalArgumentException - if portal is null or json is null or empty
        Since:
        100.0.0
      • toJson

        public String toJson()
        Description copied from interface: JsonSerializable
        Serializes this object to a JSON string. Note that unknown JSON is omitted from the serialized string.
        Specified by:
        toJson in interface JsonSerializable
        Returns:
        a JSON string
      • getUnknownJson

        public Map<String,Object> getUnknownJson()
        Description copied from interface: JsonSerializable
        If this object was created from JSON, this method gets unknown data from the source JSON. Unknown JSON is a Map of values that were in the source JSON but are not known by the Runtime and therefore not exposed in the API.
        Specified by:
        getUnknownJson in interface JsonSerializable
        Returns:
        an unmodifiable Map containing unknown JSON data. The keys are Strings containing names. The types of the values depend on the types of tokens within the JSON as follows:
        • a Map<String, Object> represents an object in the JSON
        • a List<Object> represents an array in the JSON
        • a String represents a string in the JSON
        • a Double represents a number in the JSON
        • a Boolean represents true or false in the JSON
        • null represents null in the JSON
      • getUnsupportedJson

        public Map<String,Object> getUnsupportedJson()
        Description copied from interface: JsonSerializable
        If this object was created from JSON, this method gets unsupported data from the source JSON. Unsupported JSON is a Map of values that are supported by webmaps and known to the version of the webmap specification the API supports (see system requirements), but are not explicitly exposed through the Runtime API.
        Specified by:
        getUnsupportedJson in interface JsonSerializable
        Returns:
        an unmodifiable Map containing unsupported JSON data. The keys are Strings containing names. The types of the values depend on the types of tokens within the JSON as follows:
        • a Map<String, Object> represents an object in the JSON
        • a List<Object> represents an array in the JSON
        • a String represents a string in the JSON
        • a Double represents a number in the JSON
        • a Boolean represents true or false in the JSON
        • null represents null in the JSON
      • getAccess

        public PortalGroup.Access getAccess()
        Gets the access level of this group, which determines who can access the content of the group.
        Returns:
        the access level of this group
        Since:
        100.0.0
        See Also:
        PortalGroup.Access
      • getCreated

        public Calendar getCreated()
        Gets the date this group was created.
        Returns:
        the date this group was created; always a GregorianCalendar using UTC time zone and English locale
        Since:
        100.0.0
      • getGroupDescription

        public String getGroupDescription()
        Gets the description of this group.
        Returns:
        the description of this group
        Since:
        100.0.0
      • getGroupId

        public String getGroupId()
        Gets the ID of this group.
        Returns:
        the ID of this group
        Since:
        100.0.0
      • getModified

        public Calendar getModified()
        Gets the date on which this group was last modified.
        Returns:
        the date on which this group was last modified; always a GregorianCalendar using UTC time zone and English locale
        Since:
        100.0.0
      • getOwner

        public String getOwner()
        Gets the username of the owner of this group.
        Returns:
        the username of the owner of this group
        Since:
        100.0.0
      • getPhone

        public String getPhone()
        Gets the contact phone number for this group.
        Returns:
        the contact phone number this group
        Since:
        100.0.0
      • getPortal

        public Portal getPortal()
        Gets the portal this group belongs to.
        Returns:
        the portal this group belongs to
        Since:
        100.0.0
      • getSnippet

        public String getSnippet()
        Gets the summary description snippet for this group.
        Returns:
        the summary description snippet for this group
        Since:
        100.0.0
      • getSortField

        public PortalGroup.SortField getSortField()
        Gets the field that items in this group are sorted by.
        Returns:
        the sort field for this group
        Since:
        100.0.0
      • getSortOrder

        public PortalGroup.SortOrder getSortOrder()
        Gets the sort order for items in this group.
        Returns:
        the sort order for items in this group
        Since:
        100.0.0
      • getTags

        public List<String> getTags()
        Gets a list of the tags associated with this group. Queries can use the 'tags' field to find groups with particular tags.
        Returns:
        an unmodifiable list of the tags associated with this group. This will throw an UnsupportedOperationException if an attempt is made to modify it.
        Since:
        100.0.0
      • getThumbnailFileName

        public String getThumbnailFileName()
        Gets the filename of the thumbnail for this group.
        Returns:
        the filename of the thumbnail for this group
        Since:
        100.0.0
      • getTitle

        public String getTitle()
        Gets the title of this group.
        Returns:
        the title of this group
        Since:
        100.0.0
      • isInvitationOnly

        public boolean isInvitationOnly()
        Returns whether or not this group requires an invitation to join.
        Returns:
        true if this group requires an invitation to join
        Since:
        100.0.0
      • isViewOnly

        public boolean isViewOnly()
        Returns whether or not this group is 'view only', in which case members are not able to share items to the group.
        Returns:
        true if this group is 'view only'
        Since:
        100.0.0
      • fetchThumbnailAsync

        public ListenableFuture<byte[]> fetchThumbnailAsync()
        Executes an asynchronous operation to fetch the thumbnail for this group. The result is a byte[] containing the thumbnail data, or null if there is no thumbnail for this group.
        Returns:
        a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException with its cause set to an exception as follows:
        Since:
        100.0.0
      • fetchGroupUsersAsync

        public ListenableFuture<PortalGroupUsers> fetchGroupUsersAsync()
        Executes an asynchronous operation to fetch the administrators and users for this group. The result is a PortalGroupUsers object containing the administrators and users for this group.
        Returns:
        a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException with its cause set to an exception as follows:
        Since:
        100.0.0