GroupCreateOpts

public class GroupCreateOpts : SdkObject

Options for group creation.

  • Default GroupCreateOpts for common use cases.

    The group will be assigned an ID and have an empty name. The user who creates the group will be the owner of the group as well as the only admin and member of the group. The group’s private key will not be marked for rotation.

    Declaration

    Swift

    public convenience init()
  • Constructs a GroupCreateOpts.

    Declaration

    Swift

    public convenience init(
        id: GroupId?,
        name: GroupName?,
        addAsAdmin: Bool,
        addAsMember: Bool,
        owner: UserId?,
        admins: [UserId],
        members: [UserId],
        needsRotation: Bool
    )

    Parameters

    id

    The provided ID will be used as the group’s ID. If nil, the server will assign the group’s ID.

    name

    The provided name will be used as the group’s name. If nil, the name will be empty.

    add_as_admin

    Whether the creating user should be added as a group admin.

    add_as_member

    Whether the creating user should be added as a group member.

    owner

    The provided user will be the owner of the group. If nil, the creating user will be the group owner.

    admins

    The list of users to be added as group admins.

    members

    The list of users to be added as group members.

    needsRotation

    Whether the group’s private key should be marked for rotation.