Class GroupCreateOpts


  • public final class GroupCreateOpts
    extends java.lang.Object
    Options for group creation.
    • Constructor Detail

      • GroupCreateOpts

        public GroupCreateOpts()
      • GroupCreateOpts

        public GroupCreateOpts​(GroupId id,
                               GroupName name,
                               boolean addAsAdmin,
                               boolean addAsMember,
                               UserId owner,
                               UserId[] admins,
                               UserId[] members,
                               boolean needsRotation)
        Parameters:
        id - unique id of a group within a segment. If null, the server will assign an id.
        name - human readable name of the group. Does not need to be unique.
        addAsAdmin - if true (default), the creating user will be added as a group admin.
        addAsMember - if true (default), the creating user will be added to the group's membership.
        owner - if null (default), the creating user will be the owner of the group, else the specified user will be the owner and automatically added as an admin.
        admins - list of users to be added as admins of the group. This list takes priority over `addAsAdmin`, so the creating user will be added as an admin even if `addAsAdmin` is false.
        members - list of users to be added as members of the group. This list takes priority over `addAsMember`, so the creating user will be added as a member even if `addAsMember` is false.
        needsRotation - if true, the group will be marked as needing its private key rotated.
    • Method Detail

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • delete

        public void delete()
      • finalize

        protected void finalize()
                         throws java.lang.Throwable
        Overrides:
        finalize in class java.lang.Object
        Throws:
        java.lang.Throwable
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object