Class PortalGroup

Represents a group within the portal (e.g., "San Bernardino Fires" ).

Inheritance

System.Object

PortalGroup

Implements

ILoadable

System.Text.Json.Serialization.IJsonOnSerializing

System.Text.Json.Serialization.IJsonOnDeserialized

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Esri.ArcGISRuntime.Portal

Assembly: Esri.ArcGISRuntime.dll

Syntax

[DataContract]
public sealed class PortalGroup : ILoadable, IJsonOnSerializing, IJsonOnDeserialized

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.

Constructors

Name	Description
PortalGroup(ArcGISPortal, String)	Initializes a new instance of the PortalGroup class.

Properties

Name	Description
Access	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.
Created	Gets the date the group was created.
GroupDescription	Gets the detailed description of the group.
GroupId	Gets the group id.
IsInvitationOnly	Gets a value indicating whether this instance is invitation only.
IsViewOnly	Gets a value indicating whether the group members are not able to share items to the group.
LoadError	Gets the System.Exception associated with the last load error.
LoadStatus	Gets the load status.
Modified	Gets the date the group was last modified.
Owner	Gets the username of the group's owner.
Phone	Gets the contact phone number for the group.
Portal	Gets the ArcGIS portal.
Snippet	Gets a short summary that describes the group.
SortField	Gets the sort field to use for this group.
SortOrder	Gets the sort order to use for this group.
Tags	Gets the tags.
ThumbnailUri	Gets the thumbnail URI.
Title	Gets the group title. This is the name that is displayed to users and by which they refer to the group.

Methods

Name	Description
CancelLoad()	Cancel loading metadata for the object.
FindItemsAsync(PortalGroupContentSearchParameters)	Finds portal items that belong to this group and match the given search parameters.
FindItemsAsync(PortalGroupContentSearchParameters, CancellationToken)	Finds portal items that belong to this group and match the given search parameters.
GetGroupUsersAsync()	Gets the users, owner, and administrators of the group.
GetGroupUsersAsync(CancellationToken)	Gets the users, owner, and administrators of the group.
GetThumbnailDataAsync()	Get the thumbnail image data for this portal group.
GetThumbnailDataAsync(CancellationToken)	Get the thumbnail image data for this portal group.
LoadAsync()	Load the metadata for the object asynchronously.
RetryLoadAsync()	Loads or retries loading metadata for the object asynchronously.

Events

Name	Description
Loaded	Event that is raised when the object is done loading.
LoadStatusChanged	Event that is raised when the LoadStatus property changes.

Name	Description
IJsonOnDeserialized.OnDeserialized()
IJsonOnSerializing.OnSerializing()

Applies to

Target	Versions
.NET Standard 2.0	100.3 - 200.6
.NET	100.13 - 200.6
.NET Windows	100.13 - 200.6
.NET Android	200.0 - 200.6
.NET iOS	200.0 - 200.6
.NET Framework	100.0 - 200.6
Xamarin.Android	100.0 - 100.15
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.6