PortalGroup class final
Collections of fully populated PortalGroup objects can be obtained by calling the Portal.findGroups,
Portal.fetchFeaturedGroups, and PortalItem.fetchGroups methods, and from the
PortalUser.groups property. The load status of such objects is LoadStatus.loaded.
Alternatively, a PortalGroup object can be constructed using PortalGroup.new 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.
- Mixed-in types
Constructors
- PortalGroup({required Portal portal, required String groupId})
- Constructor for use when the group ID is known.
Properties
- access → PortalAccess
-
The access level of the group's content.
no setter
- created → DateTime?
-
The date the group was created.
no setter
- groupDescription → String
-
The description of the group.
no setter
- groupId → String
-
The identifier of the group.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isInvitationOnly → bool
-
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.
no setter
- isViewOnly → bool
-
The property indicates the group is view only or not. Users cannot share items with view only groups.
no setter
- loadError → ArcGISException?
-
The load error.
no setterinherited
- loadStatus → LoadStatus
-
The load status.
no setterinherited
- modified → DateTime?
-
The date the group was modified.
no setter
-
onLoadStatusChanged
→ Stream<
LoadStatus> -
A stream that reports changes to the LoadStatus.
no setterinherited
- owner → String
-
The user who created the group.
no setter
- phone → String
-
The contact information for the group.
no setter
- portal → Portal
-
The portal to which the group belongs.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- snippet → String
-
Snippet or summary of the group with a character limit of 250 characters.
no setter
- sortField → PortalGroupSortField
-
The sort field for the group's content.
no setter
- sortOrder → PortalQuerySortOrder
-
The sort order for the group's content.
no setter
-
A list of words or short phrases that describe the group.
no setter
- thumbnail → LoadableImage?
-
The thumbnail image of the group. If it is null, there is no group thumbnail.
Otherwise, the image needs to be loaded asynchronously by using LoadableImage.load.
no setter
- title → String
-
The group title.
no setter
Methods
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
fetchGroupUsers(
) → Future< PortalGroupUsers> - Fetches users and administrators of this group.
-
load(
) → Future< void> -
Loads the metadata for the object asynchronously.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited