DBTEAMGroupUpdateArgs

Objective-C

@interface DBTEAMGroupUpdateArgs
    : DBTEAMIncludeMembersArg <DBSerializable, NSCopying>

Swift

class DBTEAMGroupUpdateArgs : DBTEAMIncludeMembersArg, DBSerializable, NSCopying

The GroupUpdateArgs struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • Specify a group.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMGroupSelector *_Nonnull group;

    Swift

    var group: DBTEAMGroupSelector { get }

  • Optional argument. Set group name to this if provided.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *dNewGroupName;

    Swift

    var dNewGroupName: String? { get }

  • Optional argument. New group external ID. If the argument is None, the group’s external_id won’t be updated. If the argument is empty string, the group’s external id will be cleared.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *dNewGroupExternalId;

    Swift

    var dNewGroupExternalId: String? { get }

  • Set new group management type, if provided.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBTEAMCOMMONGroupManagementType *dNewGroupManagementType;

    Swift

    var dNewGroupManagementType: DBTEAMCOMMONGroupManagementType? { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGroup:(nonnull DBTEAMGroupSelector *)group
                        returnMembers:(nullable NSNumber *)returnMembers
                        dNewGroupName:(nullable NSString *)dNewGroupName
                  dNewGroupExternalId:(nullable NSString *)dNewGroupExternalId
              dNewGroupManagementType:
                  (nullable DBTEAMCOMMONGroupManagementType *)
                      dNewGroupManagementType;

    Swift

    init(group: DBTEAMGroupSelector, returnMembers: NSNumber?, dNewGroupName: String?, dNewGroupExternalId: String?, dNewGroupManagementType: DBTEAMCOMMONGroupManagementType?)

    Parameters

    group

    Specify a group.
    returnMembers

    Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups.
    dNewGroupName

    Optional argument. Set group name to this if provided.
    dNewGroupExternalId

    Optional argument. New group external ID. If the argument is None, the group’s external_id won’t be updated. If the argument is empty string, the group’s external id will be cleared.
    dNewGroupManagementType

    Set new group management type, if provided.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGroup:(nonnull DBTEAMGroupSelector *)group;

    Swift

    init(group: DBTEAMGroupSelector)

    Parameters

    group

    Specify a group.

    Return Value

    An initialized instance.