Click or drag to resize

PortalGroup Class

Represents a group within the portal (e.g., "San Bernardino Fires" ).
Inheritance Hierarchy
SystemObject
  Esri.ArcGISRuntime.PortalPortalGroup

Namespace:  Esri.ArcGISRuntime.Portal
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.11.0
Syntax
public sealed class PortalGroup : ILoadable

The PortalGroup type exposes the following members.

Constructors
  NameDescription
Public methodPortalGroup
Initializes a new instance of the PortalGroup class.
Top
Properties
  NameDescription
Public propertyAccess
Gets the access level on the group. Private is the default. If Organization, only members of the organization can access the group. If Public, all users can access the group.
Public propertyCreated
Gets the date the group was created.
Public propertyGroupDescription
Gets the detailed description of the group.
Public propertyGroupId
Gets the group id.
Public propertyIsInvitationOnly
Gets a value indicating whether this instance is invitation only.
Public propertyIsViewOnly
Gets a value indicating whether the group members are not able to share items to the group.
Public propertyLoadError
Gets the Exception associated with the last load error.
Public propertyLoadStatus
Gets the load status.
Public propertyModified
Gets the date the group was last modified.
Public propertyOwner
Gets the username of the group's owner.
Public propertyPhone
Gets the contact phone number for the group.
Public propertyPortal
Gets the ArcGIS portal.
Public propertySnippet
Gets a short summary that describes the group.
Public propertySortField
Gets the sort field to use for this group.
Public propertySortOrder
Gets the sort order to use for this group.
Public propertyTags
Gets the tags.
Public propertyThumbnailUri
Gets the thumbnail URI.
Public propertyTitle
Gets the group title. This is the name that is displayed to users and by which they refer to the group.
Top
Methods
  NameDescription
Public methodCancelLoad
Cancel loading metadata for the object.
Public methodFindItemsAsync(PortalGroupContentSearchParameters)
Finds portal items that belong to this group and match the given search parameters.
Public methodFindItemsAsync(PortalGroupContentSearchParameters, CancellationToken)
Finds portal items that belong to this group and match the given search parameters.
Public methodGetGroupUsersAsync
Gets the users, owner, and administrators of the group.
Public methodGetGroupUsersAsync(CancellationToken)
Gets the users, owner, and administrators of the group.
Public methodGetThumbnailDataAsync
Get the thumbnail image data for this portal group.
Public methodGetThumbnailDataAsync(CancellationToken)
Get the thumbnail image data for this portal group.
Public methodLoadAsync
Load the metadata for the object asynchronously.
Public methodRetryLoadAsync
Loads or retries loading metadata for the object asynchronously.
Top
Events
  NameDescription
Public eventLoaded
Event that is raised when the object is done loading.
Public eventLoadStatusChanged
Event that is raised when the LoadStatus property changes.
Top
Remarks

Collections of fully populated PortalGroup objects can be obtained by calling the FindGroupsAsync(PortalQueryParameters), GetFeaturedGroupsAsync, and GetGroupsAsync methods, and from the Groups property. The load status of such objects is Loaded.

Alternatively a PortalGroup object can be constructed using PortalGroup(ArcGISPortal, String) if the group ID is known. In that case the load status is initially NotLoaded 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 see the group.

Administrators can invite, add to, and remove members from a group, and also update or 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.

See Also