PortalGroup QML Type

Represents a group within a Portal or Organization. More...

Import Statement:	import Esri.ArcGISRuntime 100.15
Since:	Esri.ArcGISRuntime 100.0
Inherits:	Object

List of all members, including inherited members

Properties

access : Enums.PortalAccess
admins : list<string>
created : date
fetchGroupUsersStatus : Enums.TaskStatus
groupDescription : string
groupId : string
invitationOnly : bool
json : jsobject
loadError : Error
loadStatus : Enums.LoadStatus
modified : date
owner : string
phone : string
portal : Portal
snippet : string
sortField : Enums.PortalGroupSortField
sortOrder : Enums.PortalQuerySortOrder
tags : list<string>
thumbnailUrl : url
title : string
unknownJson : jsobject
unsupportedJson : jsobject
users : list<string>
viewOnly : bool

Signals

accessChanged()
createdChanged()
fetchGroupUsersStatusChanged()
groupDescriptionChanged()
groupIdChanged()
invitationOnlyChanged()
loadErrorChanged()
loadStatusChanged()
modifiedChanged()
ownerChanged()
phoneChanged()
portalChanged()
snippetChanged()
sortFieldChanged()
sortOrderChanged()
tagsChanged()
thumbnailUrlChanged()
titleChanged()
viewOnlyChanged()

Methods

void cancelLoad()
void fetchGroupUsers()
void load()
void retryLoad()

Detailed Description

Collections of fully populated PortalGroup objects can be obtained by calling Portal::findGroups, Portal::fetchFeaturedGroups, and PortalItem::fetchGroups, and from the PortalUser::groups property. The load status of such objects is Loaded.

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.

A PortalGroup may be created with a portal and a groupId, but both must be provided during creation time.

Property Documentation

access : Enums.PortalAccess

Returns the access level for the group (read-only).

See also Enums.PortalAccess.

admins : list<string>

Returns the users that are administrators of the group (read-only).

created : date

Returns the time the group was created (read-only).

Always a Gregorian calendar using UTC time zone and English locale.

fetchGroupUsersStatus : Enums.TaskStatus

Returns the status of the fetchGroupUsers task (read-only).

See also Enums.TaskStatus.

groupDescription : string

Returns the group description (read-only).

groupId : string

Returns the group ID.

This property can be assigned but must be assigned at creation time.

invitationOnly : bool

Returns whether group membership is invitation-only (read-only).

If this is set to true, users will not be able to apply to join the group.

json : jsobject

The JSON representation of the PortalGroup.

portal is conserved

loadError : Error

Returns the load error (read-only).

Note: Load errors are also reported on the error property and emit the errorChanged signal.

This property was introduced in Esri.ArcGISRuntime 100.13.

See also Loadable.

loadStatus : Enums.LoadStatus

Returns the load status (read-only).

This property was introduced in Esri.ArcGISRuntime 100.13.

See also Loadable and Enums.LoadStatus.

modified : date

Returns the time the group was last modified (read-only).

Always a Gregorian calendar using UTC time zone and English locale.

owner : string

Returns the username of the owner of the group (read-only).

phone : string

Returns the telephone number of the group (read-only).

[default] portal : Portal

Returns the portal associated with the group.

This property can be assigned but must be assigned at creation time.

snippet : string

Returns the summary description snippet for this group (read-only).

sortField : Enums.PortalGroupSortField

Returns the field that items in this group are sorted by.

See also Enums.PortalGroupSortField.

sortOrder : Enums.PortalQuerySortOrder

Returns the sort order for items in this group.

See also Enums.PortalQuerySortOrder.

tags : list<string>

Returns the user-defined tags that describe the group.

Queries can use the tags field to find groups with particular tags.

See also PortalQueryParametersForGroups.

thumbnailUrl : url

Returns the URL of the thumbnail used for the group.

All group thumbnails are relative to the URL: https://<community-url>/groups/<groupId>/info.

title : string

Returns the title of the group (read-only).

unknownJson : jsobject

Returns the unknown JSON from the source JSON.

See also JsonSerializable.

unsupportedJson : jsobject

Returns the unsupported data from the source JSON.

See also JsonSerializable.

users : list<string>

Returns a list of strings representing users of the group.

viewOnly : bool

Returns whether group membership is view-only (read-only).

Signal Documentation

accessChanged()

Emitted when the access property changes.

Note: The corresponding handler is onAccessChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

createdChanged()

Emitted when the created property changes.

Note: The corresponding handler is onCreatedChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

fetchGroupUsersStatusChanged()

Emitted when the fetchGroupUsersStatus property changes.

Note: The corresponding handler is onFetchGroupUsersStatusChanged.

groupDescriptionChanged()

Emitted when the groupDescription property changes.

Note: The corresponding handler is onGroupDescriptionChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

groupIdChanged()

Emitted when the groupId property changes.

Note: The corresponding handler is onGroupIdChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

invitationOnlyChanged()

Emitted when the invitationOnly property changes.

Note: The corresponding handler is onInvitationOnlyChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

loadErrorChanged()

Emitted when the loadError property changes.

Note: The corresponding handler is onLoadErrorChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

loadStatusChanged()

Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

modifiedChanged()

Emitted when the modified property changes.

Note: The corresponding handler is onModifiedChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

ownerChanged()

Emitted when the owner property changes.

Note: The corresponding handler is onOwnerChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

phoneChanged()

Emitted when the phone property changes.

Note: The corresponding handler is onPhoneChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

portalChanged()

Emitted when the portal property changes.

Note: The corresponding handler is onPortalChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

snippetChanged()

Emitted when the snippet property changes.

Note: The corresponding handler is onSnippetChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

sortFieldChanged()

Emitted when the sortField property changes.

Note: The corresponding handler is onSortFieldChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

sortOrderChanged()

Emitted when the sortOrder property changes.

Note: The corresponding handler is onSortOrderChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

tagsChanged()

Emitted when the tags property changes.

Note: The corresponding handler is onTagsChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

thumbnailUrlChanged()

Emitted when the thumbnailUrl property changes.

Note: The corresponding handler is onThumbnailUrlChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

titleChanged()

Emitted when the title property changes.

Note: The corresponding handler is onTitleChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

viewOnlyChanged()

Emitted when the viewOnly property changes.

Note: The corresponding handler is onViewOnlyChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

Method Documentation

void cancelLoad()

This method was introduced in Esri.ArcGISRuntime 100.13.

See also Loadable.

void fetchGroupUsers()

Starts an operation to fetch users and admins of the group.

The fetchGroupUsersStatus property indicates the status of the operation.

void load()

This method was introduced in Esri.ArcGISRuntime 100.13.

See also Loadable.

void retryLoad()

This method was introduced in Esri.ArcGISRuntime 100.13.

See also Loadable.