Class PortalGroup
- java.lang.Object
-
- com.esri.arcgisruntime.portal.PortalGroup
-
- All Implemented Interfaces:
JsonSerializable
,Loadable
public final class PortalGroup extends Object implements Loadable, JsonSerializable
Represents a group within a portal.Collections of fully populated
PortalGroup
objects can be obtained by calling thePortal.findGroupsAsync(PortalQueryParameters)
,Portal.fetchFeaturedGroupsAsync()
,PortalItem.fetchGroupsAsync()
andPortalUser.getGroups()
methods. The load status of such objects isLoadStatus.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 initiallyLoadStatus.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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PortalGroup.Access
Signifies the level of access to a portal group, which determines who can access the content of the group.static class
PortalGroup.SortField
Signifies the field that items in a portal group are sorted by.static class
PortalGroup.SortOrder
Signifies the sort order for items in a portal group.
-
Constructor Summary
Constructors Constructor Description PortalGroup(Portal portal, String groupId)
Constructor for use when the group ID is known.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDoneLoadingListener(Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.void
addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
cancelLoad()
Cancels loading metadata for the object.ListenableFuture<PortalGroupUsers>
fetchGroupUsersAsync()
Executes an asynchronous operation to fetch the administrators and users for this group.ListenableFuture<byte[]>
fetchThumbnailAsync()
Executes an asynchronous operation to fetch the thumbnail for this group.ListenableFuture<PortalGroupContentSearchResultSet>
findItemsAsync(PortalGroupContentSearchParameters searchParams)
Executes an asynchronous operation to find portal items that belong to this group and match the given search parameters.static PortalGroup
fromJson(String json, Portal portal)
Creates a PortalGroup instance from a JSON string.PortalGroup.Access
getAccess()
Gets the access level of this group, which determines who can access the content of the group.Calendar
getCreated()
Gets the date this group was created.String
getGroupDescription()
Gets the description of this group.String
getGroupId()
Gets the ID of this group.ArcGISRuntimeException
getLoadError()
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.LoadStatus
getLoadStatus()
Returns theLoadStatus
of the loadable resource.Calendar
getModified()
Gets the date on which this group was last modified.String
getOwner()
Gets the username of the owner of this group.String
getPhone()
Gets the contact phone number for this group.Portal
getPortal()
Gets the portal this group belongs to.String
getSnippet()
Gets the summary description snippet for this group.PortalGroup.SortField
getSortField()
Gets the field that items in this group are sorted by.PortalGroup.SortOrder
getSortOrder()
Gets the sort order for items in this group.List<String>
getTags()
Gets a list of the tags associated with this group.String
getThumbnailFileName()
Gets the filename of the thumbnail for this group.String
getTitle()
Gets the title of this group.Map<String,Object>
getUnknownJson()
If this object was created from JSON, this method gets unknown data from the source JSON.Map<String,Object>
getUnsupportedJson()
If this object was created from JSON, this method gets unsupported data from the source JSON.boolean
isInvitationOnly()
Returns whether or not this group requires an invitation to join.boolean
isViewOnly()
Returns whether or not this group is 'view only', in which case members are not able to share items to the group.void
loadAsync()
Loads the metadata of the loadable resource asynchronously.boolean
removeDoneLoadingListener(Runnable listener)
Removes a done loading listener from the loadable resource.boolean
removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Removes aLoadStatusChangedListener
from the loadable resource.void
retryLoadAsync()
Loads or retries loading metadata for the object asynchronously.String
toJson()
Serializes this object to a JSON string.
-
-
-
Constructor Detail
-
PortalGroup
public PortalGroup(Portal portal, String groupId)
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 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 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
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 interfaceJsonSerializable
- 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 interfaceJsonSerializable
- 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
- a
-
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 interfaceJsonSerializable
- 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
- a
-
getLoadStatus
public LoadStatus getLoadStatus()
Description copied from interface:Loadable
Returns theLoadStatus
of the loadable resource.- Specified by:
getLoadStatus
in interfaceLoadable
- Returns:
- the LoadStatus of the loadable resource
-
getLoadError
public ArcGISRuntimeException getLoadError()
Description copied from interface:Loadable
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.If the resource subsequently transitions to
LoadStatus.LOADED
(for example, if a call toretryLoadAsync
completes successfully) the error is cleared out.- Specified by:
getLoadError
in interfaceLoadable
- Returns:
- the most recent error that was encountered when the loadable resource transitioned to the
LoadStatus.FAILED_TO_LOAD
state.
-
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
public void addDoneLoadingListener(Runnable listener)
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, use the
Loadable.addLoadStatusChangedListener(LoadStatusChangedListener)
method instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
public boolean removeDoneLoadingListener(Runnable listener)
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
public void addLoadStatusChangedListener(LoadStatusChangedListener listener)
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
public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
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
-
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:IOException
if the network request fails
- 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 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
-
-