ResourceList Event

Fires once for each resource returned when listing resources or versions.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireResourceList(BoxResourceListEventParams *e);

typedef struct {
  const char *Id;
  const char *Name;
  const char *Description;
  int ResourceType;
  const char *CreatedTime;
  const char *ModifiedTime;
  int64 Size;
  const char *VersionId;
  const char *ETag;
  const char *Hash;
  int Trashed;
  const char *SharedLink;
  int reserved;
} BoxResourceListEventParams;

Unicode (Windows)
virtual INT FireResourceList(BoxResourceListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Name;
  LPCWSTR Description;
  INT ResourceType;
  LPCWSTR CreatedTime;
  LPCWSTR ModifiedTime;
  LONG64 Size;
  LPCWSTR VersionId;
  LPCWSTR ETag;
  LPCWSTR Hash;
  BOOL Trashed;
  LPCWSTR SharedLink;
  INT reserved;
} BoxResourceListEventParams;

- (void)onResourceList:(NSString*)id :(NSString*)name :(NSString*)description :(int)resourceType :(NSString*)createdTime :(NSString*)modifiedTime :(long long)size :(NSString*)versionId :(NSString*)ETag :(NSString*)hash :(BOOL)trashed :(NSString*)sharedLink;

#define EID_BOX_RESOURCELIST 8

virtual INT IPWORKSCLOUD_CALL FireResourceList(LPSTR &lpszId, LPSTR &lpszName, LPSTR &lpszDescription, INT &iResourceType, LPSTR &lpszCreatedTime, LPSTR &lpszModifiedTime, LONG64 &lSize, LPSTR &lpszVersionId, LPSTR &lpszETag, LPSTR &lpszHash, BOOL &bTrashed, LPSTR &lpszSharedLink);

Remarks

This event fires once for each resource returned when ListResources, GetResourceInfo, Search, or ListVersions is called.

Id is the Id of the resource.

Name is the name of the resource.

Description is a description of the resource.

ResourceType reflects the resource's type. Possible values are:

CreatedTime and ModifiedTime reflect the resource's creation and last modified timestamps. Timestamps are formatted according to RFC 3339.

Size is the size of the resource (for folders, their contents' total size), in bytes.

VersionId is the version Id of the file resource. Not applicable for file resources. (Note that Box only tracks file versions for paid accounts.)

ETag is the ETag of the resource.

Hash holds a SHA1 hash of the file resource's content. Not applicable for folder resources.

Trashed indicates whether the resource is in the trash.

SharedLink is the shared link URL for the resource. May be empty if the resource doesn't have a shared link active.