Requesting metadata information when getting file data #554

minahattoriBOX · 2018-07-23T19:10:58Z

No description provided.

boxcla · 2018-07-23T19:11:06Z

Verified that @minahattoriBOX has signed the CLA. Thanks for the pull request!

jdizoglio · 2018-07-23T20:27:05Z

BoxContentSDK/BoxContentSDK/Clients/BOXContentClient+Folder.h

+ *
+ *  @param folderID Folder ID.
+ *  @param templateKey  The template key for specific metadata template
+ *  @param scope    The scope that then metadata is in


?? 'The scope that then metadata is in'

jdizoglio · 2018-07-23T20:30:49Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderItemsRequest+Metadata.m

+
+- (instancetype) initWithFolderID:(NSString *)folderID templateKey: (NSString *)templateKey scope: (NSString *)scope
+{
+    if  (self = [super init]){


nit, space 'if (self = [super init]){'

jdizoglio · 2018-07-23T20:31:24Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderPaginatedItemsRequest.h


+//Metadata information parameters
+@property (nonatomic, readwrite, strong) NSString *templateKey;
+@property (nonatomic, readwrite, strong) NSString *scope;


What is scope?

These should be copy, rather than strong. This applies basically to all NSString, NSArray, NSData, etc.

jdizoglio · 2018-07-23T20:31:44Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderPaginatedItemsRequest.m


+- (instancetype) initWithFolderID:(NSString *)folderID templateKey: (NSString *)templateKey scope: (NSString *)scope inRange:(NSRange)range
+{
+    if  (self = [super init]){


ric0liva · 2018-07-23T20:35:18Z

BoxContentSDK/BoxContentSDK/Clients/BOXContentClient+Folder.h

+ */
+- (BOXFolderItemsRequest *)folderItemsRequestWithID:(NSString *)folderID
+                                        templateKey:(NSString *)templateKey
+                                              scope: (NSString *)scope;


Lets rename this parameters so it's clear they are associated with metadata:
templateKey -> metadataTemplateKey
scope -> metadataScope

ric0liva · 2018-07-23T22:43:20Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderPaginatedItemsRequest.m

+{
+    if (self = [super init]){
+        _folderID = folderID;
+        _limit = range.length;


Nit: traditionally, pagination params (limit and offset) go after the item attribute params.

ric0liva · 2018-07-23T22:48:16Z

BoxContentSDK/BoxContentSDKTests/BOXFolderPaginatedItemsRequestTests.m

+    BOXFolderPaginatedItemsRequest *request = [[BOXFolderPaginatedItemsRequest alloc] initWithFolderID:@"123" inRange:NSMakeRange(0,5)];
+    request.requestAllItemFields = YES;
+
+    NSString *expectedFieldString = @"type,id,sequence_id,etag,name,description,size,path_collection,created_at,modified_at,trashed_at,purged_at,content_created_at,content_modified_at,created_by,modified_by,owned_by,shared_link,parent,item_status,permissions,lock,extension,is_package,allowed_shared_link_access_levels,collections,collection_memberships,folder_upload_email,sync_state,has_collaborations,is_externally_owned,can_non_owners_invite,allowed_invitee_roles,sha1,version_number,comment_count,url";


Lets make this string a constant, that we can re-use above.

ric0liva · 2018-07-23T22:59:52Z

BoxContentSDK/BoxContentSDK/Clients/BOXContentClient+Folder.h

+ *
+ *  @param folderID Folder ID.
+ *  @param metadataTemplateKey  The template key for specific metadata template
+ *  @param metadataScope    The scope that then metadata is in


Nit. Consistent comment with 204.

jlawton

Love the added tests!

jlawton · 2018-07-23T23:33:16Z

BoxContentSDK/BoxContentSDK/Clients/BOXContentClient+Folder.h

+ *
+ *  @return A request that can be customized and then executed.
+ */
+- (BOXFolderPaginatedItemsRequest *)folderPaginatedItemsRequestWithID:(NSString *)folderID


Nit: Align : on these lines.

jlawton · 2018-07-23T23:33:28Z

BoxContentSDK/BoxContentSDK/Clients/BOXContentClient+Folder.h

+ */
+- (BOXFolderItemsRequest *)folderItemsRequestWithID:(NSString *)folderID
+                                        metadataTemplateKey:(NSString *)metadataTemplateKey
+                                              metadataScope: (BOXMetadataScope)metadataScope;


Nit: No space after : here.

jlawton · 2018-07-23T23:33:46Z

BoxContentSDK/BoxContentSDK/Clients/BOXContentClient+Folder.m

 }

+- (BOXFolderItemsRequest *)folderItemsRequestWithID:(NSString *)folderID
+                                        metadataTemplateKey: (NSString *)metadataTemplateKey


Nit: Align : and remove spaces.

jlawton · 2018-07-23T23:34:06Z

BoxContentSDK/BoxContentSDK/Clients/BOXContentClient+Folder.m

 }

+- (BOXFolderPaginatedItemsRequest *)folderPaginatedItemsRequestWithID:(NSString *)folderID
+                                                          metadataTemplateKey: (NSString *)metadataTemplateKey


Nit: Align : and remove spaces.

jlawton · 2018-07-23T23:34:19Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderItemsRequest+Metadata.h

+
+@interface BOXFolderItemsRequest (Metadata)
+
+@property (nonatomic, readwrite, strong) NSString *folderID;


jlawton · 2018-07-23T23:35:47Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderItemsRequest+Metadata.m

+
+- (instancetype)initWithFolderID:(NSString *)folderID metadataTemplateKey: (NSString *)metadataTemplateKey metadataScope: (BOXMetadataScope)metadataScope
+{
+    if (self = [super init]){


Nit: Space before {

jlawton · 2018-07-23T23:36:10Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderItemsRequest.m

+    BOXFolderPaginatedItemsRequest *paginatedRequest = nil;
+
+    if (self.metadataTemplateKey != nil && self.metadataScope != nil) {
+        paginatedRequest = [[BOXFolderPaginatedItemsRequest alloc] initWithFolderID:self.folderID metadataTemplateKey: self.metadataTemplateKey metadataScope: self.metadataScope inRange:range];


Nit: Not spaces after :

jlawton · 2018-07-23T23:36:31Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderPaginatedItemsRequest.h

+@property (nonatomic, readwrite, copy) BOXMetadataScope metadataScope;
+
 - (instancetype)initWithFolderID:(NSString *)folderID inRange:(NSRange)range;
+- (instancetype)initWithFolderID:(NSString *)folderID metadataTemplateKey: (NSString *)metadataTemplateKey metadataScope: (BOXMetadataScope)metadataScope inRange:(NSRange)range;


Nit: No spaces after :

jlawton · 2018-07-23T23:36:54Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderPaginatedItemsRequest.m

    return self;
 }

+- (instancetype) initWithFolderID:(NSString *)folderID metadataTemplateKey: (NSString *)metadataTemplateKey metadataScope: (BOXMetadataScope)metadataScope inRange:(NSRange)range


Nit: No spaces after : or (instancetype)

jlawton · 2018-07-23T23:37:06Z

BoxContentSDK/BoxContentSDK/Requests/BOXFolderPaginatedItemsRequest.m


+- (instancetype) initWithFolderID:(NSString *)folderID metadataTemplateKey: (NSString *)metadataTemplateKey metadataScope: (BOXMetadataScope)metadataScope inRange:(NSRange)range
+{
+    if (self = [super init]){


Nit: Space before {

jdizoglio reviewed Jul 23, 2018

View reviewed changes

ric0liva reviewed Jul 23, 2018

View reviewed changes

minahattoriBOX changed the title ~~Requesting metadata information when getting file data~~ IOS-16067 Requesting metadata information when getting file data Jul 23, 2018

minahattoriBOX changed the title ~~IOS-16067 Requesting metadata information when getting file data~~ IOS-16067: Requesting metadata information when getting file data Jul 23, 2018

minahattoriBOX changed the title ~~IOS-16067: Requesting metadata information when getting file data~~ Requesting metadata information when getting file data Jul 23, 2018

minahattoriBOX force-pushed the IOS-16067 branch from 5b23a56 to 1fdd16f Compare July 23, 2018 22:37

ric0liva reviewed Jul 23, 2018

View reviewed changes

minahattoriBOX force-pushed the IOS-16067 branch from 1fdd16f to 138c9bc Compare July 23, 2018 22:57

ric0liva reviewed Jul 23, 2018

View reviewed changes

minahattoriBOX force-pushed the IOS-16067 branch from 138c9bc to 5aadc01 Compare July 23, 2018 23:08

ric0liva approved these changes Jul 23, 2018

View reviewed changes

minahattoriBOX force-pushed the IOS-16067 branch from 5aadc01 to 7f65284 Compare July 23, 2018 23:25

jlawton reviewed Jul 23, 2018

View reviewed changes

minahattoriBOX force-pushed the IOS-16067 branch from 7f65284 to 0eb4b49 Compare July 23, 2018 23:57

Requesting metadata information when getting file data

a342226

minahattoriBOX force-pushed the IOS-16067 branch from 0eb4b49 to a342226 Compare July 24, 2018 00:21

jlawton approved these changes Jul 24, 2018

View reviewed changes

minahattoriBOX merged commit d48a4e9 into master Jul 24, 2018

minahattoriBOX deleted the IOS-16067 branch July 24, 2018 17:15


		@interface BOXFolderItemsRequest (Metadata)

		@property (nonatomic, readwrite, strong) NSString *folderID;

Requesting metadata information when getting file data #554

Requesting metadata information when getting file data #554

Uh oh!

Conversation

minahattoriBOX commented Jul 23, 2018

Uh oh!

boxcla commented Jul 23, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jlawton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants