DBTEAMLOGGetTeamEventsArg

Objective-C

@interface DBTEAMLOGGetTeamEventsArg : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLOGGetTeamEventsArg : NSObject, DBSerializable, NSCopying

The GetTeamEventsArg 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

  • The maximal number of results to return per call. Note that some calls may not return limit number of events, and may even return no events, even with has_more set to true. In this case, callers should fetch again using getEventsContinue.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull limit;

    Swift

    var limit: NSNumber { get }

  • Filter the events by account ID. Return only events with this account_id as either Actor, Context, or Participants.

    Declaration

    Objective-C

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

    Swift

    var accountId: String? { get }

  • Filter by time range.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBTEAMCOMMONTimeRange *time;

    Swift

    var time: DBTEAMCOMMONTimeRange? { get }

  • Filter the returned events to a single category. Note that category shouldn’t be provided together with event_type.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBTEAMLOGEventCategory *category;

    Swift

    var category: DBTEAMLOGEventCategory? { get }

  • Filter the returned events to a single event type. Note that event_type shouldn’t be provided together with category.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBTEAMLOGEventTypeArg *eventType;

    Swift

    var eventType: DBTEAMLOGEventTypeArg? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithLimit:(nullable NSNumber *)limit
        accountId:(nullable NSString *)accountId
             time:(nullable DBTEAMCOMMONTimeRange *)time
         category:(nullable DBTEAMLOGEventCategory *)category
        eventType:(nullable DBTEAMLOGEventTypeArg *)eventType;

    Swift

    init(limit: NSNumber?, accountId: String?, time: DBTEAMCOMMONTimeRange?, category: DBTEAMLOGEventCategory?, eventType: DBTEAMLOGEventTypeArg?)

    Parameters

    limit

    The maximal number of results to return per call. Note that some calls may not return limit number of events, and may even return no events, even with has_more set to true. In this case, callers should fetch again using getEventsContinue.
    accountId

    Filter the events by account ID. Return only events with this account_id as either Actor, Context, or Participants.
    time

    Filter by time range.
    category

    Filter the returned events to a single category. Note that category shouldn’t be provided together with event_type.
    eventType

    Filter the returned events to a single event type. Note that event_type shouldn’t be provided together with category.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initDefault;

    Swift

    init(default: ())

    Return Value

    An initialized instance.