arcgis-maps-kotlin/com.arcgismaps.portal/PortalGroup

PortalGroup

data class PortalGroup : Loadable, JsonSerializable

Represents a group within a portal.

Collections of fully populated PortalGroup objects can be obtained by calling the Portal.waitFindGroups(PortalQueryParameters), Portal.fetchFeaturedGroupsAsync(), and PortalItem.fetchGroupsAsync() methods, and from the PortalUser.getGroups() property. The load status of such objects is LoadStatus.Loaded.

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

200.0.0

Constructors

PortalGroup

fun PortalGroup(portal: Portal, groupId: String)

Constructs a PortalGroup with the given Portal and group ID.

Types

Companion

object Companion

Functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

fetchGroupUsers

suspend fun fetchGroupUsers(): Result<PortalGroupUsers>

Fetches users and administrators of this group.

findItems

suspend fun findItems(searchParams: PortalGroupContentSearchParameters): Result<PortalGroupContentSearchResultSet>

Finds portal items that belong to this group and match the given search parameters.

load

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

retryLoad

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

toJson

open override fun toJson(): String

Convert the PortalGroup to a JSON string.

Properties

access

val access: PortalAccess?

The access level of the group's content. Remark: If null, the access is unknown.

creationDate

val creationDate: Instant?

The date on which the group was created.

description

val description: String

The description of the group.

val id: String

the ID of the group

isInvitationOnly

val isInvitationOnly: Boolean

The property indicates whether the group will not accept join requests. If true, only group owners and admins can invite users to the group. Otherwise, this group does not require an invitation to join.

isViewOnly

val isViewOnly: Boolean

The property indicates the group is view only or not. Users cannot share items with view only groups.

loadStatus