readdle / box-ios-sdk

iOS SDK for the Box Content API

NOTE:

The iOS SDK in Objective-C (prior to v3.0.0) has been moved from the master branch to this objective-c-maintenance branch. Going forward, the master branch will contain the iOS SDK in Swift, starting with v3.0.0.

Box iOS SDK

This SDK makes it easy to use Box's Content API in your iOS projects.

Developer Setup

• Ensure you have the latest version of Xcode installed.
• We encourage you to use [Carthage] (https://github.com/Carthage/Carthage#installing-carthage) to manage dependencies. Minimal supported version for Carthage is 0.22.0.

Quickstart

Step 1: Add to your Cartfile

github "box/box-ios-sdk" "objective-c-maintenance"

Step 2: Update

carthage update --platform iOS

Step 3: Drag the built framework from Carthage/Build/iOS into your project. For more detailed instructions please see the official documentation for Carthage (https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos).

Step 4: Import

@import BoxContentSDK;

Step 5: Set the Box Client ID and Client Secret that you obtain from creating your app.

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // The UIApplicationDelegate is a good place to do this.
  [BOXContentClient setClientID:@"your-client-id" clientSecret:@"your-client-secret"];
}

Step 6: Authenticate a User

// This will present the necessary UI for a user to authenticate into Box
[[BOXContentClient defaultClient] authenticateWithCompletionBlock:^(BOXUser *user, NSError *error) {
  if (error == nil) {
    NSLog(@"Logged in user: %@", user.login);
  }
}];

Sample App

A sample app can be found in the BoxContentSDKSampleApp folder. The sample app demonstrates how to authenticate a user, and manage the user's files and folders.

To execute the sample app: Step 1: Open Workspace

open BoxContentSDKSampleApp.xcworkspace

Tests

Tests can be found in the 'BoxContentSDKTests' target. Use Xcode to execute the tests. Travis CI will also execute tests for pull requests and pushes to the repository.

Documentation

You can find guides and tutorials in the doc directory.

• App Setup
• Authentication
• Developer's Edition (App Users)
• Files
• Folders
• Metadata
• Comments
• Collaborations
• Events
• Search
• Users

Contributing

See CONTRIBUTING on how to help out.

Copyright and License

Copyright 2019 Box, Inc. All rights reserved.

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.