- All Implemented Interfaces:
JsonSerializable
,Loadable
Collections of fully populated PortalGroup
objects can be obtained by calling the
Portal.findGroupsAsync(PortalQueryParameters)
, Portal.fetchFeaturedGroupsAsync()
,
PortalItem.fetchGroupsAsync()
and PortalUser.getGroups()
methods. The load status of such objects is
LoadStatus.LOADED
.
Alternatively a PortalGroup object can be constructed using PortalGroup(Portal, String)
if the group ID is
known. In that case the load status is initially LoadStatus.NOT_LOADED
and the object needs to be loaded to
populate its properties.
The portal group owner is automatically an administrator and is returned in the list of admins. The access property determines the visibility of the group to other users. If the group is private, no one except the administrators and the members of the group can see it. If the group is shared with an organization, then all members of the organization can see the group.
Administrators can invite, add to, and remove members from a group, and also update and delete the group. The administrator for an organization may also reassign the group to another member of the organization. Group members may leave the group. Authenticated users may apply to join a group.
- Since:
- 100.0.0
-
Property Summary
TypePropertyDescriptionThe load error.The load status. -
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Signifies the level of access to a portal group, which determines who can access the content of the group.static enum
Signifies the field that items in a portal group are sorted by.static enum
Signifies the sort order for items in a portal group. -
Constructor Summary
ConstructorDescriptionPortalGroup
(Portal portal, String groupId) Constructor for use when the group ID is known. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDoneLoadingListener
(Runnable listener) Adds a listener to the loadable resource that is invoked when loading has completed.void
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
Cancels loading metadata for the object.Executes an asynchronous operation to fetch the administrators and users for this group.ListenableFuture
<byte[]> Executes an asynchronous operation to fetch the thumbnail for this group.findItemsAsync
(PortalGroupContentSearchParameters searchParams) Executes an asynchronous operation to find portal items that belong to this group and match the given search parameters.static PortalGroup
Creates a PortalGroup instance from a JSON string.Gets the access level of this group, which determines who can access the content of the group.Gets the date this group was created.Gets the description of this group.Gets the ID of this group.Gets the value of theloadError
property.Gets the value of theloadStatus
property.Gets the date on which this group was last modified.getOwner()
Gets the username of the owner of this group.getPhone()
Gets the contact phone number for this group.Gets the portal this group belongs to.Gets the summary description snippet for this group.Gets the field that items in this group are sorted by.Gets the sort order for items in this group.getTags()
Gets a list of the tags associated with this group.Gets the filename of the thumbnail for this group.getTitle()
Gets the title of this group.Gets unknown data from the source JSON.Gets unsupported data from the source JSON.boolean
Returns whether or not this group requires an invitation to join.boolean
Returns whether or not this group is 'view only', in which case members are not able to share items to the group.void
Loads the metadata of the loadable resource asynchronously.The load error.The load status.boolean
removeDoneLoadingListener
(Runnable listener) Removes a done loading listener from the loadable resource.boolean
Removes aLoadStatusChangedListener
from the loadable resource.void
Loads or retries loading metadata for the object asynchronously.toJson()
Serializes this object to a JSON string.
-
Property Details
-
loadStatus
- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
loadError
- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
-
Constructor Details
-
PortalGroup
Constructor for use when the group ID is known.- Parameters:
portal
- the portal the group belongs togroupId
- the ID of the group- Throws:
IllegalArgumentException
- if portal is null or groupId is null or empty- Since:
- 100.8.0
-
-
Method Details
-
fromJson
Creates a PortalGroup instance from a JSON string.- Parameters:
json
- a JSON string that represents a PortalGroupportal
- 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
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 interfaceJsonSerializable
- Returns:
- a JSON string
-
getUnknownJson
Description copied from interface:JsonSerializable
Gets unknown data from the source JSON.Unknown JSON is a Map of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.
- Specified by:
getUnknownJson
in interfaceJsonSerializable
- Returns:
- an unmodifiable Map containing unknown data from the source JSON
-
getUnsupportedJson
Description copied from interface:JsonSerializable
Gets unsupported data from the source JSON.Unsupported JSON is a Map of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.
- Specified by:
getUnsupportedJson
in interfaceJsonSerializable
- Returns:
- an unmodifiable Map containing unsupported data from the source JSON
-
getLoadStatus
Gets the value of theloadStatus
property.- Specified by:
getLoadStatus
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadStatus
property - See Also:
-
getLoadError
Gets the value of theloadError
property.- Specified by:
getLoadError
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadError
property - See Also:
-
cancelLoad
public void cancelLoad()Description copied from interface:Loadable
Cancels loading metadata for the object.Cancels loading the metadata if the object is loading, and always invokes the done loading listener.
A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by calling this method and the resource will transition fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.getLoadError()
.Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.
This method does nothing if the resource is not in
LoadStatus.LOADING
state.- Specified by:
cancelLoad
in interfaceLoadable
-
loadAsync
public void loadAsync()Description copied from interface:Loadable
Loads the metadata of the loadable resource asynchronously.The load status changes from
LoadStatus.NOT_LOADED
toLoadStatus.LOADING
. A listener can be added viaLoadable.addDoneLoadingListener(java.lang.Runnable)
that is invoked upon completion of the asynchronous load operation.If the load operation completes successfully, the load status will be
LoadStatus.LOADED
, which means the resource has loaded its metadata.If the load operation failed, the load status will be
LoadStatus.FAILED_TO_LOAD
and the error can be retrieved by callingLoadable.getLoadError()
.This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (
LoadStatus.LOADING
state) whenloadAsync
is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
is called, the done loading listener is immediately invoked when added to the loadable resource.If a loadable resource has failed to load, calling
loadAsync
on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource,Loadable.retryLoadAsync()
needs to be used.A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by callingLoadable.cancelLoad()
. -
retryLoadAsync
public void retryLoadAsync()Description copied from interface:Loadable
Loads or retries loading metadata for the object asynchronously.Will retry loading the metadata if the object's load status is
LoadStatus.FAILED_TO_LOAD
. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.For more details on the load process see
Loadable.loadAsync()
.- Specified by:
retryLoadAsync
in interfaceLoadable
-
addDoneLoadingListener
Description copied from interface:Loadable
Adds a listener to the loadable resource that is invoked when loading has completed.The listener may be added at any point, whether the loadable resource has already completed loading or not.
- For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.
Alternatively, to be notified when there is any change in the load status, add a listener to the
Loadable.loadStatusProperty()
instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
Description copied from interface:Loadable
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the
Loadable.addDoneLoadingListener(Runnable)
method.- Specified by:
addLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
loadStatusProperty
Description copied from interface:Loadable
The load status.- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
loadErrorProperty
Description copied from interface:Loadable
The load error.- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
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:
-
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
Gets the description of this group.- Returns:
- the description of this group
- Since:
- 100.0.0
-
getGroupId
Gets the ID of this group.- Returns:
- the ID of this group
- Since:
- 100.0.0
-
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
Gets the username of the owner of this group.- Returns:
- the username of the owner of this group
- Since:
- 100.0.0
-
getPhone
Gets the contact phone number for this group.- Returns:
- the contact phone number this group
- Since:
- 100.0.0
-
getPortal
Gets the portal this group belongs to.- Returns:
- the portal this group belongs to
- Since:
- 100.0.0
-
getSnippet
Gets the summary description snippet for this group.- Returns:
- the summary description snippet for this group
- Since:
- 100.0.0
-
getSortField
Gets the field that items in this group are sorted by.- Returns:
- the sort field for this group
- Since:
- 100.0.0
-
getSortOrder
Gets the sort order for items in this group.- Returns:
- the sort order for items in this group
- Since:
- 100.0.0
-
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
Gets the filename of the thumbnail for this group.- Returns:
- the filename of the thumbnail for this group
- Since:
- 100.0.0
-
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
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:IOException
if the network request fails
- Since:
- 100.0.0
-
fetchGroupUsersAsync
Executes an asynchronous operation to fetch the administrators and users for this group. The result is aPortalGroupUsers
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:IOException
if the network request fails
- Since:
- 100.0.0
-
findItemsAsync
public ListenableFuture<PortalGroupContentSearchResultSet> findItemsAsync(PortalGroupContentSearchParameters searchParams) Executes an asynchronous operation to find portal items that belong to this group and match the given search parameters. The result is a PortalGroupContentSearchResultSet object containing thePortalItem
s that were found.This method uses a Group Content Search operation that's designed specifically for finding items that belong to a group. It differs from the
Portal.findItemsAsync(PortalQueryParameters)
method which uses a general-purpose Search operation that's suitable for searching all items stored on a portal.The behavior of this method differs from the
Portal.findItemsAsync(PortalQueryParameters)
method in the following ways:- If the
PortalGroupContentSearchParameters.getCategories()
property is used, the categories specified there will be matched with group categories that have been specified by the group owner/administrator, as opposed to the organization-level categories that the general-purpose Search operation matches against. - An extra
PortalGroupContentSearchParameters.getSortField()
option is available, "added", to sort the results on the time the items were added to the group.
- Parameters:
searchParams
- the search parameters- 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 anExecutionException
with its cause set to an exception as follows:IOException
if the network request fails
- Throws:
IllegalArgumentException
- if searchParams is null- Since:
- 100.7.0
- If the
-