DBTEAMGetStorageReport

Objective-C

@interface DBTEAMGetStorageReport
    : DBTEAMBaseDfbReport <DBSerializable, NSCopying>

Swift

class DBTEAMGetStorageReport : DBTEAMBaseDfbReport, DBSerializable, NSCopying

The GetStorageReport struct.

Storage Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.

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

Instance fields

  • Sum of the shared, unshared, and datastore usages, for each day.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSNumber *> *_Nonnull totalUsage;

    Swift

    var totalUsage: [NSNumber] { get }
  • Array of the combined size (bytes) of team members’ shared folders, for each day.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSNumber *> *_Nonnull sharedUsage;

    Swift

    var sharedUsage: [NSNumber] { get }
  • Array of the combined size (bytes) of team members’ root namespaces, for each day.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSNumber *> *_Nonnull unsharedUsage;

    Swift

    var unsharedUsage: [NSNumber] { get }
  • Array of the number of shared folders owned by team members, for each day.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSNumber *> *_Nonnull sharedFolders;

    Swift

    var sharedFolders: [NSNumber] { get }
  • Array of storage summaries of team members’ account sizes. Each storage summary is an array of key, value pairs, where each pair describes a storage bucket. The key indicates the upper bound of the bucket and the value is the number of users in that bucket. There is one such summary per day. If there is no data for a day, the storage summary will be empty.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSArray<DBTEAMStorageBucket *> *> *_Nonnull memberStorageMap;

    Swift

    var memberStorageMap: [[DBTEAMStorageBucket]] { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
        initWithStartDate:(nonnull NSString *)startDate
               totalUsage:(nonnull NSArray<NSNumber *> *)totalUsage
              sharedUsage:(nonnull NSArray<NSNumber *> *)sharedUsage
            unsharedUsage:(nonnull NSArray<NSNumber *> *)unsharedUsage
            sharedFolders:(nonnull NSArray<NSNumber *> *)sharedFolders
         memberStorageMap:
             (nonnull NSArray<NSArray<DBTEAMStorageBucket *> *> *)memberStorageMap;

    Swift

    init(startDate: String, totalUsage: [NSNumber], sharedUsage: [NSNumber], unsharedUsage: [NSNumber], sharedFolders: [NSNumber], memberStorageMap: [[DBTEAMStorageBucket]])

    Parameters

    startDate

    First date present in the results as ‘YYYY-MM-DD’ or None.

    totalUsage

    Sum of the shared, unshared, and datastore usages, for each day.

    sharedUsage

    Array of the combined size (bytes) of team members’ shared folders, for each day.

    unsharedUsage

    Array of the combined size (bytes) of team members’ root namespaces, for each day.

    sharedFolders

    Array of the number of shared folders owned by team members, for each day.

    memberStorageMap

    Array of storage summaries of team members’ account sizes. Each storage summary is an array of key, value pairs, where each pair describes a storage bucket. The key indicates the upper bound of the bucket and the value is the number of users in that bucket. There is one such summary per day. If there is no data for a day, the storage summary will be empty.

    Return Value

    An initialized instance.