box-ios-sdk-v2-metadata 0.4.0

Maintained by Unclaimed.

You want to add pod 'box-ios-sdk-v2-metadata', '~> 0.4' similar to the following to your Podfile:

target 'MyApp' do
  pod 'box-ios-sdk-v2-metadata', '~> 0.4'
end

Then run a pod install inside your terminal, or from CocoaPods.app.

Alternatively to give it a test run, run the command:

pod try box-ios-sdk-v2-metadata

box-ios-sdk-v2-metadata 0.4.0

By
Ryan Lopopolo

Important Notice

Box's metadata functionality is in beta and is subject to frequent change. Do not use it with production content as the data will be frequently purged. By using the beta, you are acknowledging that you have read and agreed to our beta terms of service. If you have questions, send an email to [email protected].

Overview

This is a plugin for box-ios-sdk-v2 that enables beta support for Box's metadata API. See metadata API documentation and product documentation.

Note: This library and the HTTP API it wraps are in beta and may undergo breaking changes.

Usage

Use BoxSDK as you normally would. Whenever you wish to use the metadata API,

#import <BoxSDK/BoxSDK.h>
#import <BoxSDKMetadata/BoxSDKMetadata.h>

to include a category on BoxSDK that exposes a metadata API manager.

Make an API call like this:

[[BoxSDK sharedSDK].metadataManager itemMetadataForFileWithID:fileID
                                               requestBuilder:nil
                                                      success:success
                                                      failure:failure];

Because the metadata API is in beta, it has not been activated for all users. To ensure the API is activated for the currently authorized user, enable a feature flag:

// enable metadata API
[BoxSDK sharedSDK].metadataManager.shouldEnableMetadataAPIsForAllUsers = YES;

Note: Box may change which classes of users are enabled to use the metadata feature.

Requirements

This plugin depends on box-ios-sdk v1.2.2 and greater.

Installation

Tests

Unit tests are runnable by executing:

rake spec

Copyright and License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.