PortalGroup

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

Link copied to clipboard
constructor(portal: Portal, groupId: String)

Constructs a PortalGroup with the given Portal and group ID.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

The date on which the group was created.

Link copied to clipboard

The description of the group.

Link copied to clipboard
val id: String

the ID of the group

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The date on which the group was modified.

Link copied to clipboard

The user who created the group.

Link copied to clipboard

The contact information for the group.

Link copied to clipboard

the Portal in which this group exists

Link copied to clipboard

Snippet or summary of the group with a character limit of 250 characters.

Link copied to clipboard

The sort field for the group's content.

Link copied to clipboard

The sort order for the group's content.

Link copied to clipboard

A list of words or short phrases that describe the group.

Link copied to clipboard
@Serializable(with = LoadableImageSerializer::class)
val 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.

Link copied to clipboard

The group title.

Inherited properties

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

Link copied to clipboard

Fetches users and administrators of this group.

Link copied to clipboard

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

Link copied to clipboard
open override fun toJson(): String

Convert the PortalGroup to a JSON string.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.