diff --git a/BoxSDK.podspec b/BoxSDK.podspec index 6fdabbcab..8d98b221f 100644 --- a/BoxSDK.podspec +++ b/BoxSDK.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |spec| spec.name = "BoxSDK" - spec.version = "4.4.0" + spec.version = "5.0.0" spec.summary = "Box Swift SDK" spec.description = <<-DESC Official Box Swift SDK. diff --git a/CHANGELOG.md b/CHANGELOG.md index 1653bb9e8..dab965f07 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,14 @@ Changelog __Breaking Changes:__ +__New Features and Enhancements:__ + +__Bug Fixes:__ + +## v5.0.0 [2021-10-28] + +__Breaking Changes:__ + - Update PagingIterator to return pages and simplify logic ([#737](https://github.com/box/box-ios-sdk/pull/737)) - Remove insensitive language field `collaborationWhiteList` in BoxClient. Use `collaborationAllowList` instead. ([#790](https://github.com/box/box-ios-sdk/pull/790)) @@ -13,8 +21,6 @@ __New Features and Enhancements:__ - Replace insensitive event types ([#785](https://github.com/box/box-ios-sdk/pull/785)) - Add SignAPI support ([#792](https://github.com/box/box-ios-sdk/pull/792)) -__Bug Fixes:__ - ## v4.4.0 [2021-04-20] __Breaking Changes:__ diff --git a/SampleApps/JWTSampleApp/Cartfile b/SampleApps/JWTSampleApp/Cartfile index fd135f95f..8ed0c6350 100644 --- a/SampleApps/JWTSampleApp/Cartfile +++ b/SampleApps/JWTSampleApp/Cartfile @@ -1 +1 @@ -git "https://github.com/box/box-ios-sdk.git" ~> 4.0 +git "https://github.com/box/box-ios-sdk.git" ~> 5.0 diff --git a/SampleApps/OAuth2SampleApp/Cartfile b/SampleApps/OAuth2SampleApp/Cartfile index fd135f95f..8ed0c6350 100644 --- a/SampleApps/OAuth2SampleApp/Cartfile +++ b/SampleApps/OAuth2SampleApp/Cartfile @@ -1 +1 @@ -git "https://github.com/box/box-ios-sdk.git" ~> 4.0 +git "https://github.com/box/box-ios-sdk.git" ~> 5.0 diff --git a/Sources/Info.plist b/Sources/Info.plist index b3d1fb15d..a6cf6e847 100644 --- a/Sources/Info.plist +++ b/Sources/Info.plist @@ -2,12 +2,6 @@ - boxOAuthURL - $(boxOAuthURL) - uploadApiBaseURL - $(uploadApiBaseURL) - apiBaseURL - $(apiBaseURL) CFBundleDevelopmentRegion en CFBundleExecutable @@ -21,10 +15,16 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 4.4.0 + 5.0.0 CFBundleVersion $(CURRENT_PROJECT_VERSION) NSPrincipalClass + apiBaseURL + $(apiBaseURL) + boxOAuthURL + $(boxOAuthURL) + uploadApiBaseURL + $(uploadApiBaseURL) diff --git a/docs/Classes.html b/docs/Classes.html index 3cad9d0c4..4acadcaff 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -17,18 +17,18 @@
-

BoxSDK 4.4.0 Docs (100% documented)

-

+

BoxSDK 5.0.0 Docs (100% documented)

+
-

+
@@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1517,6 +1565,34 @@

Declaration

+
  • +
    + + + + SignRequestsModule + +
    +
    +
    +
    +
    +
    +

    Provides management of Sign Requests

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestsModule
    + +
    +
    +
    +
    +
  • @@ -2298,7 +2374,8 @@

    Declaration

    Declaration

    Swift

    -
    public class EventContainer : BoxModel
    +
    @available(*, deprecated, message: "This class is obsoleted and will be removed. Please use EntryContainer<Element> instead.")
    +public class EventContainer : BoxModel
    @@ -3176,6 +3253,176 @@

    Declaration

  • +
  • +
    + + + + SignRequest + +
    +
    +
    +
    +
    +
    +

    A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequest : BoxModel
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestPrefillTag + +
    +
    +
    +
    +
    +
    +

    Prefill tags are used to prefill placeholders with signer input data. +Only one value field can be included.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestPrefillTag : BoxInnerModel
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestSignFiles + +
    +
    +
    +
    +
    +
    +

    List of files that will be signed, which are copies of the original source files. +A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestSignFiles : BoxModel
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestSigner + +
    +
    +
    +
    +
    +
    +

    Represents a signer fields for GET Sign Request response.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestSigner : BoxModel
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestSignerDecision + +
    +
    +
    +
    +
    +
    +

    Final decision made by the signer

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestSignerDecision : BoxModel
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestSignerInput + +
    +
    +
    +
    +
    +
    +

    Prefill tags are used to prefill placeholders with signer input data. Only none value field can be included.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestSignerInput : BoxModel
    + +
    +
    +
    +
    +
  • @@ -3424,7 +3671,8 @@

    Declaration

    Declaration

    Swift

    -
    public class TrackingCode : BoxModel
    +
    @available(*, deprecated, message: "This class is obsoleted and will be removed. Please use User.TrackingCode instead.")
    +public class TrackingCode : BoxModel
    @@ -3829,11 +4077,10 @@

    Declaration

    - diff --git a/docs/Classes/AuthModule.html b/docs/Classes/AuthModule.html index 28d98e9ae..514b30a01 100644 --- a/docs/Classes/AuthModule.html +++ b/docs/Classes/AuthModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1041,11 +1089,10 @@

    Parameters

    - diff --git a/docs/Classes/BoxAPIError.html b/docs/Classes/BoxAPIError.html index 0d8a1426a..6e9ce5b42 100644 --- a/docs/Classes/BoxAPIError.html +++ b/docs/Classes/BoxAPIError.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/Classes/BoxClient.html b/docs/Classes/BoxClient.html index 33bd89c21..56e927ef4 100644 --- a/docs/Classes/BoxClient.html +++ b/docs/Classes/BoxClient.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1039,33 +1087,6 @@

    Declaration

    -
  • -
    - - - - collaborationWhiteList - -
    -
    -
    -
    -
    -
    -

    Provides collaborations whitelist functionality (deprecated)

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public private(set) lazy var collaborationWhiteList: CollaborationAllowlistModule { get set }
    - -
    -
    -
    -
    -
  • @@ -1417,6 +1438,33 @@

    Declaration

  • +
  • +
    + + + + signRequests + +
    +
    +
    +
    +
    +
    +

    Provides sign requests functionality.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public private(set) lazy var signRequests: SignRequestsModule { get set }
    + +
    +
    +
    +
    +
  • @@ -1875,7 +1923,7 @@

    Parameters

    -

    BoxClientProtocol methods

    +

    BoxClientProtocol methods

    @@ -2812,11 +2860,10 @@

    Return Value

    - diff --git a/docs/Classes/BoxCollection.html b/docs/Classes/BoxCollection.html index b11147424..4e800dd82 100644 --- a/docs/Classes/BoxCollection.html +++ b/docs/Classes/BoxCollection.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -774,7 +822,7 @@

    BoxCollection

    -

    Properties

    +

    Properties

    @@ -970,11 +1018,10 @@

    Parameters

    - diff --git a/docs/Classes/BoxNetworkAgent.html b/docs/Classes/BoxNetworkAgent.html index b7f5e4108..21e1e5ace 100644 --- a/docs/Classes/BoxNetworkAgent.html +++ b/docs/Classes/BoxNetworkAgent.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -882,11 +930,10 @@

    Parameters

    - diff --git a/docs/Classes/BoxNetworkTask.html b/docs/Classes/BoxNetworkTask.html index 9f0bbf19f..a4a56ee7e 100644 --- a/docs/Classes/BoxNetworkTask.html +++ b/docs/Classes/BoxNetworkTask.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/Classes/BoxRequest.html b/docs/Classes/BoxRequest.html index db2463270..69db54c5f 100644 --- a/docs/Classes/BoxRequest.html +++ b/docs/Classes/BoxRequest.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -801,11 +849,10 @@

    Declaration

    - diff --git a/docs/Classes/BoxRequest/BodyType.html b/docs/Classes/BoxRequest/BodyType.html index f7109c254..faa1ffe4b 100644 --- a/docs/Classes/BoxRequest/BodyType.html +++ b/docs/Classes/BoxRequest/BodyType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -935,11 +983,10 @@

    Declaration

    - diff --git a/docs/Classes/BoxSDK.html b/docs/Classes/BoxSDK.html index ec00f78f8..da61dbd54 100644 --- a/docs/Classes/BoxSDK.html +++ b/docs/Classes/BoxSDK.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1176,7 +1224,7 @@

    Parameters

    Declaration

    Swift

    -
    @available(iOS 13.0, *)
    +                          
    @available(iOS 13.0, *)
     public func getOAuth2Client(
         tokenInfo: TokenInfo? = nil,
         tokenStore: TokenStore? = nil,
    @@ -1264,7 +1312,7 @@ 

    Parameters

    Declaration

    Swift

    -
    @available(iOS 11.0, *)
    +                          
    @available(iOS 11.0, *)
     public func getOAuth2Client(
         tokenInfo: TokenInfo? = nil,
         tokenStore: TokenStore? = nil,
    @@ -1327,7 +1375,7 @@ 

    Parameters

    -

    Configuration

    +

    Configuration

    @@ -1467,7 +1515,7 @@

    Parameters

    -

    AuthenticationSession

    +

    AuthenticationSession

    @@ -1528,11 +1576,10 @@

    Return Value

    - diff --git a/docs/Classes/BoxSDK/Constants.html b/docs/Classes/BoxSDK/Constants.html index 9a432f30d..704eaaacd 100644 --- a/docs/Classes/BoxSDK/Constants.html +++ b/docs/Classes/BoxSDK/Constants.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/Classes/BoxSDKError.html b/docs/Classes/BoxSDKError.html index b3a05097c..a84d7c367 100644 --- a/docs/Classes/BoxSDKError.html +++ b/docs/Classes/BoxSDKError.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -963,11 +1011,10 @@

    Declaration

    - diff --git a/docs/Classes/Classification.html b/docs/Classes/Classification.html index 8b1943d88..b6aa93c3f 100644 --- a/docs/Classes/Classification.html +++ b/docs/Classes/Classification.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Classification

    -

    Properties

    +

    Properties

    @@ -940,11 +988,10 @@

    Parameters

    - diff --git a/docs/Classes/Collaboration.html b/docs/Classes/Collaboration.html index d4fc45fb1..08727183e 100644 --- a/docs/Classes/Collaboration.html +++ b/docs/Classes/Collaboration.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -830,7 +878,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1357,11 +1405,10 @@

    Declaration

    - diff --git a/docs/Classes/Collaboration/AcceptanceRequirementsStatus.html b/docs/Classes/Collaboration/AcceptanceRequirementsStatus.html index daced37bc..db615734c 100644 --- a/docs/Classes/Collaboration/AcceptanceRequirementsStatus.html +++ b/docs/Classes/Collaboration/AcceptanceRequirementsStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -944,11 +992,10 @@

    Parameters

    - diff --git a/docs/Classes/Collaboration/StrongPasswordRequirement.html b/docs/Classes/Collaboration/StrongPasswordRequirement.html index 4e1ee3ce1..ec4f00ef8 100644 --- a/docs/Classes/Collaboration/StrongPasswordRequirement.html +++ b/docs/Classes/Collaboration/StrongPasswordRequirement.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -918,11 +966,10 @@

    Parameters

    - diff --git a/docs/Classes/Collaboration/TermsOfServiceRequirement.html b/docs/Classes/Collaboration/TermsOfServiceRequirement.html index cdd34b7b6..a63d4bd68 100644 --- a/docs/Classes/Collaboration/TermsOfServiceRequirement.html +++ b/docs/Classes/Collaboration/TermsOfServiceRequirement.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -917,11 +965,10 @@

    Parameters

    - diff --git a/docs/Classes/Collaboration/TwoFactorAuthenticationRequirement.html b/docs/Classes/Collaboration/TwoFactorAuthenticationRequirement.html index 9b4156233..ee65bd218 100644 --- a/docs/Classes/Collaboration/TwoFactorAuthenticationRequirement.html +++ b/docs/Classes/Collaboration/TwoFactorAuthenticationRequirement.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -917,11 +965,10 @@

    Parameters

    - diff --git a/docs/Classes/CollaborationAllowlistEntry.html b/docs/Classes/CollaborationAllowlistEntry.html index 8a82be078..c9cb1e99f 100644 --- a/docs/Classes/CollaborationAllowlistEntry.html +++ b/docs/Classes/CollaborationAllowlistEntry.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    CollaborationAllowlistEntry

    -

    BoxModel

    +

    BoxModel

    @@ -1049,11 +1097,10 @@

    Parameters

    - diff --git a/docs/Classes/CollaborationAllowlistExemptTarget.html b/docs/Classes/CollaborationAllowlistExemptTarget.html index c46dd3654..c582e8429 100644 --- a/docs/Classes/CollaborationAllowlistExemptTarget.html +++ b/docs/Classes/CollaborationAllowlistExemptTarget.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    CollaborationAllowlistExemptTarget

    -

    BoxModel

    +

    BoxModel

    @@ -1022,11 +1070,10 @@

    Parameters

    - diff --git a/docs/Classes/CollaborationAllowlistModule.html b/docs/Classes/CollaborationAllowlistModule.html index a30515b60..9910d5b1d 100644 --- a/docs/Classes/CollaborationAllowlistModule.html +++ b/docs/Classes/CollaborationAllowlistModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1367,11 +1415,10 @@

    Parameters

    - diff --git a/docs/Classes/CollaborationsModule.html b/docs/Classes/CollaborationsModule.html index 7aab9a1af..5152c65a9 100644 --- a/docs/Classes/CollaborationsModule.html +++ b/docs/Classes/CollaborationsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1468,11 +1516,10 @@

    Parameters

    - diff --git a/docs/Classes/Collaborator.html b/docs/Classes/Collaborator.html index 18f6ebe64..1c4b1c6a6 100644 --- a/docs/Classes/Collaborator.html +++ b/docs/Classes/Collaborator.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Collaborator

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/Classes/Collaborator/CollaboratorType.html b/docs/Classes/Collaborator/CollaboratorType.html index 882d5daba..14ba0f48c 100644 --- a/docs/Classes/Collaborator/CollaboratorType.html +++ b/docs/Classes/Collaborator/CollaboratorType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/Classes/CollectionsModule.html b/docs/Classes/CollectionsModule.html index 3bed3d9cf..f928d19db 100644 --- a/docs/Classes/CollectionsModule.html +++ b/docs/Classes/CollectionsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -990,11 +1038,10 @@

    Parameters

    - diff --git a/docs/Classes/Comment.html b/docs/Classes/Comment.html index fa959f457..3c75d320f 100644 --- a/docs/Classes/Comment.html +++ b/docs/Classes/Comment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    Comment

    -

    Properties

    +

    Properties

    @@ -1104,11 +1152,10 @@

    Parameters

    - diff --git a/docs/Classes/CommentsModule.html b/docs/Classes/CommentsModule.html index e19ad186b..bcb8353c5 100644 --- a/docs/Classes/CommentsModule.html +++ b/docs/Classes/CommentsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1078,11 +1126,10 @@

    Parameters

    - diff --git a/docs/Classes/ConsoleLogDestination.html b/docs/Classes/ConsoleLogDestination.html index 327ad6196..f8ea0519b 100644 --- a/docs/Classes/ConsoleLogDestination.html +++ b/docs/Classes/ConsoleLogDestination.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -855,11 +903,10 @@

    Parameters

    - diff --git a/docs/Classes/DelegatedAuthSession.html b/docs/Classes/DelegatedAuthSession.html index 262ec88e6..fc877c32d 100644 --- a/docs/Classes/DelegatedAuthSession.html +++ b/docs/Classes/DelegatedAuthSession.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -952,11 +1000,10 @@

    Parameters

    - diff --git a/docs/Classes/DevicePin.html b/docs/Classes/DevicePin.html index fa473a0d5..1d6dac62f 100644 --- a/docs/Classes/DevicePin.html +++ b/docs/Classes/DevicePin.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    DevicePin

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1034,11 +1082,10 @@

    Parameters

    - diff --git a/docs/Classes/DevicePinsModule.html b/docs/Classes/DevicePinsModule.html index b2bc0f620..970bfec5c 100644 --- a/docs/Classes/DevicePinsModule.html +++ b/docs/Classes/DevicePinsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -987,11 +1035,10 @@

    Parameters

    - diff --git a/docs/Classes/EmailAlias.html b/docs/Classes/EmailAlias.html index 25639fa86..5b185b94b 100644 --- a/docs/Classes/EmailAlias.html +++ b/docs/Classes/EmailAlias.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EmailAlias

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -980,11 +1028,10 @@

    Parameters

    - diff --git a/docs/Classes/Enterprise.html b/docs/Classes/Enterprise.html index acde2ca4d..0db90578b 100644 --- a/docs/Classes/Enterprise.html +++ b/docs/Classes/Enterprise.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Enterprise

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -953,11 +1001,10 @@

    Parameters

    - diff --git a/docs/Classes/EntryContainer.html b/docs/Classes/EntryContainer.html index 861d86421..08a8ecf3a 100644 --- a/docs/Classes/EntryContainer.html +++ b/docs/Classes/EntryContainer.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EntryContainer

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1061,11 +1109,10 @@

    Parameters

    - diff --git a/docs/Classes/EntryContainerInnerModel.html b/docs/Classes/EntryContainerInnerModel.html index c7a128ae1..ce8afd2f9 100644 --- a/docs/Classes/EntryContainerInnerModel.html +++ b/docs/Classes/EntryContainerInnerModel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EntryContainerInnerModel

    -

    Properties

    +

    Properties

    @@ -809,11 +857,10 @@

    Declaration

    - diff --git a/docs/Classes/Event.html b/docs/Classes/Event.html index 482ac39e1..8ce25c689 100644 --- a/docs/Classes/Event.html +++ b/docs/Classes/Event.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -829,7 +877,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1107,11 +1155,10 @@

    Parameters

    - diff --git a/docs/Classes/EventContainer.html b/docs/Classes/EventContainer.html index 0907ecd67..afba3b1af 100644 --- a/docs/Classes/EventContainer.html +++ b/docs/Classes/EventContainer.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -758,7 +806,8 @@

    EventContainer

    -
    public class EventContainer : BoxModel
    +
    @available(*, deprecated, message: "This class is obsoleted and will be removed. Please use EntryContainer<Element> instead.")
    +public class EventContainer : BoxModel
    @@ -772,7 +821,7 @@

    EventContainer

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +860,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1007,11 +1056,10 @@

    Parameters

    - diff --git a/docs/Classes/EventItem.html b/docs/Classes/EventItem.html index a7c5a436c..48eb6311f 100644 --- a/docs/Classes/EventItem.html +++ b/docs/Classes/EventItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EventItem

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/Classes/EventItem/EventItemType.html b/docs/Classes/EventItem/EventItemType.html index 157604107..b9ac4d203 100644 --- a/docs/Classes/EventItem/EventItemType.html +++ b/docs/Classes/EventItem/EventItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/Classes/EventsModule.html b/docs/Classes/EventsModule.html index 54a0f1515..2209f3049 100644 --- a/docs/Classes/EventsModule.html +++ b/docs/Classes/EventsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1082,11 +1130,10 @@

    Parameters

    - diff --git a/docs/Classes/ExpiringEmbedLink.html b/docs/Classes/ExpiringEmbedLink.html index 5f503df1b..89cc70aff 100644 --- a/docs/Classes/ExpiringEmbedLink.html +++ b/docs/Classes/ExpiringEmbedLink.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ExpiringEmbedLink

    -

    Properties

    +

    Properties

    @@ -913,11 +961,10 @@

    Parameters

    - diff --git a/docs/Classes/File.html b/docs/Classes/File.html index a1172e17c..786caf466 100644 --- a/docs/Classes/File.html +++ b/docs/Classes/File.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1045,7 +1093,7 @@

    Declaration

    Declaration

    Swift

    -
    public let `extension`: String?
    +
    public let `extension`: String?
    @@ -1919,11 +1967,10 @@

    Parameters

    - diff --git a/docs/Classes/File/Permissions.html b/docs/Classes/File/Permissions.html index b068ccdda..470f3c9dc 100644 --- a/docs/Classes/File/Permissions.html +++ b/docs/Classes/File/Permissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1097,11 +1145,10 @@

    Declaration

    - diff --git a/docs/Classes/FileLogDestination.html b/docs/Classes/FileLogDestination.html index ab06bc9c4..c5ce8403b 100644 --- a/docs/Classes/FileLogDestination.html +++ b/docs/Classes/FileLogDestination.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -901,11 +949,10 @@

    Parameters

    - diff --git a/docs/Classes/FileVersion.html b/docs/Classes/FileVersion.html index d3dd60fbd..7dce4ac0c 100644 --- a/docs/Classes/FileVersion.html +++ b/docs/Classes/FileVersion.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    FileVersion

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1250,11 +1298,10 @@

    Parameters

    - diff --git a/docs/Classes/FileVersionLegalHold.html b/docs/Classes/FileVersionLegalHold.html index c391ad241..0b4af903f 100644 --- a/docs/Classes/FileVersionLegalHold.html +++ b/docs/Classes/FileVersionLegalHold.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    FileVersionLegalHold

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1034,11 +1082,10 @@

    Parameters

    - diff --git a/docs/Classes/FileVersionRetention.html b/docs/Classes/FileVersionRetention.html index 3f6ec6910..b5875ea82 100644 --- a/docs/Classes/FileVersionRetention.html +++ b/docs/Classes/FileVersionRetention.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    FileVersionRetention

    -

    Properties

    +

    Properties

    @@ -1048,11 +1096,10 @@

    Parameters

    - diff --git a/docs/Classes/FilesModule.html b/docs/Classes/FilesModule.html index b964932e2..cc3fd4091 100644 --- a/docs/Classes/FilesModule.html +++ b/docs/Classes/FilesModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -4824,11 +4872,10 @@

    Return Value

    - diff --git a/docs/Classes/Folder.html b/docs/Classes/Folder.html index e7cb41969..581b5f187 100644 --- a/docs/Classes/Folder.html +++ b/docs/Classes/Folder.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1768,11 +1816,10 @@

    Parameters

    - diff --git a/docs/Classes/Folder/Permissions.html b/docs/Classes/Folder/Permissions.html index e81a9e5c5..a3c71337b 100644 --- a/docs/Classes/Folder/Permissions.html +++ b/docs/Classes/Folder/Permissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -962,11 +1010,10 @@

    Declaration

    - diff --git a/docs/Classes/FolderLock.html b/docs/Classes/FolderLock.html index 0ecd85672..29a596360 100644 --- a/docs/Classes/FolderLock.html +++ b/docs/Classes/FolderLock.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1093,11 +1141,10 @@

    Parameters

    - diff --git a/docs/Classes/FolderLock/LockedOperations.html b/docs/Classes/FolderLock/LockedOperations.html index 6b3165304..8177f2e8c 100644 --- a/docs/Classes/FolderLock/LockedOperations.html +++ b/docs/Classes/FolderLock/LockedOperations.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/Classes/FolderUploadEmail.html b/docs/Classes/FolderUploadEmail.html index 4e2aa16dd..369325e26 100644 --- a/docs/Classes/FolderUploadEmail.html +++ b/docs/Classes/FolderUploadEmail.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    FolderUploadEmail

    -

    Properties

    +

    Properties

    @@ -836,11 +884,10 @@

    Declaration

    - diff --git a/docs/Classes/FoldersModule.html b/docs/Classes/FoldersModule.html index 2872263ef..ff9403288 100644 --- a/docs/Classes/FoldersModule.html +++ b/docs/Classes/FoldersModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -2418,11 +2466,10 @@

    Parameters

    - diff --git a/docs/Classes/Group.html b/docs/Classes/Group.html index 8aa07f3ab..e7d2ba960 100644 --- a/docs/Classes/Group.html +++ b/docs/Classes/Group.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1201,11 +1249,10 @@

    Parameters

    - diff --git a/docs/Classes/Group/GroupType.html b/docs/Classes/Group/GroupType.html index 56eded29f..0f62d4006 100644 --- a/docs/Classes/Group/GroupType.html +++ b/docs/Classes/Group/GroupType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/Classes/GroupMembership.html b/docs/Classes/GroupMembership.html index 69d783fdc..a06fe0ae4 100644 --- a/docs/Classes/GroupMembership.html +++ b/docs/Classes/GroupMembership.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -1107,11 +1155,10 @@

    Parameters

    - diff --git a/docs/Classes/GroupMembership/ConfigurablePermissions.html b/docs/Classes/GroupMembership/ConfigurablePermissions.html index 64c71dc34..03e46e0c9 100644 --- a/docs/Classes/GroupMembership/ConfigurablePermissions.html +++ b/docs/Classes/GroupMembership/ConfigurablePermissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -881,11 +929,10 @@

    Declaration

    - diff --git a/docs/Classes/GroupsModule.html b/docs/Classes/GroupsModule.html index 6ea1ed8e9..05fc5e3d4 100644 --- a/docs/Classes/GroupsModule.html +++ b/docs/Classes/GroupsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1905,11 +1953,10 @@

    Parameters

    - diff --git a/docs/Classes/Invite.html b/docs/Classes/Invite.html index 5d8fc27a6..eaad456cf 100644 --- a/docs/Classes/Invite.html +++ b/docs/Classes/Invite.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Invite

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1088,11 +1136,10 @@

    Parameters

    - diff --git a/docs/Classes/KeychainTokenStore.html b/docs/Classes/KeychainTokenStore.html index 66ea33142..03f329ff5 100644 --- a/docs/Classes/KeychainTokenStore.html +++ b/docs/Classes/KeychainTokenStore.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -878,11 +926,10 @@

    Declaration

    - diff --git a/docs/Classes/LegalHoldPolicy.html b/docs/Classes/LegalHoldPolicy.html index 0bf2e0067..10d9a028d 100644 --- a/docs/Classes/LegalHoldPolicy.html +++ b/docs/Classes/LegalHoldPolicy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -832,7 +880,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -898,7 +946,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1283,11 +1331,10 @@

    Parameters

    - diff --git a/docs/Classes/LegalHoldPolicy/AssignmentCounts.html b/docs/Classes/LegalHoldPolicy/AssignmentCounts.html index 62680a7d4..50d636f61 100644 --- a/docs/Classes/LegalHoldPolicy/AssignmentCounts.html +++ b/docs/Classes/LegalHoldPolicy/AssignmentCounts.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -881,11 +929,10 @@

    Declaration

    - diff --git a/docs/Classes/LegalHoldPolicy/Status.html b/docs/Classes/LegalHoldPolicy/Status.html index 07776f4c2..28b27528f 100644 --- a/docs/Classes/LegalHoldPolicy/Status.html +++ b/docs/Classes/LegalHoldPolicy/Status.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -960,11 +1008,10 @@

    Declaration

    - diff --git a/docs/Classes/LegalHoldPolicyAssignment.html b/docs/Classes/LegalHoldPolicyAssignment.html index 174cb0379..67f6e2076 100644 --- a/docs/Classes/LegalHoldPolicyAssignment.html +++ b/docs/Classes/LegalHoldPolicyAssignment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    LegalHoldPolicyAssignment

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1061,11 +1109,10 @@

    Parameters

    - diff --git a/docs/Classes/LegalHoldPolicyAssignmentItem.html b/docs/Classes/LegalHoldPolicyAssignmentItem.html index eaa64632f..583f56f76 100644 --- a/docs/Classes/LegalHoldPolicyAssignmentItem.html +++ b/docs/Classes/LegalHoldPolicyAssignmentItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    LegalHoldPolicyAssignmentItem

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html b/docs/Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html index f8b71c16e..2ec8c838a 100644 --- a/docs/Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html +++ b/docs/Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -881,11 +929,10 @@

    Declaration

    - diff --git a/docs/Classes/LegalHoldsModule.html b/docs/Classes/LegalHoldsModule.html index 3661fa416..e9a3c6c21 100644 --- a/docs/Classes/LegalHoldsModule.html +++ b/docs/Classes/LegalHoldsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1778,11 +1826,10 @@

    Parameters

    - diff --git a/docs/Classes/Lock.html b/docs/Classes/Lock.html index 37273e1e1..783bb2f03 100644 --- a/docs/Classes/Lock.html +++ b/docs/Classes/Lock.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Lock

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1034,11 +1082,10 @@

    Parameters

    - diff --git a/docs/Classes/MetadataCascadePolicy.html b/docs/Classes/MetadataCascadePolicy.html index e9cbc0463..3eedf7ead 100644 --- a/docs/Classes/MetadataCascadePolicy.html +++ b/docs/Classes/MetadataCascadePolicy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    MetadataCascadePolicy

    -

    Properties

    +

    Properties

    @@ -1023,11 +1071,10 @@

    Parameters

    - diff --git a/docs/Classes/MetadataCascadePolicyModule.html b/docs/Classes/MetadataCascadePolicyModule.html index 47759536f..446df351c 100644 --- a/docs/Classes/MetadataCascadePolicyModule.html +++ b/docs/Classes/MetadataCascadePolicyModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1189,11 +1237,10 @@

    Parameters

    - diff --git a/docs/Classes/MetadataModule.html b/docs/Classes/MetadataModule.html index c446b9592..a58ee38a8 100644 --- a/docs/Classes/MetadataModule.html +++ b/docs/Classes/MetadataModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -2083,11 +2131,10 @@

    Parameters

    - diff --git a/docs/Classes/MetadataObject.html b/docs/Classes/MetadataObject.html index ce3ad4708..c96c3a11a 100644 --- a/docs/Classes/MetadataObject.html +++ b/docs/Classes/MetadataObject.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    MetadataObject

    -

    Properties

    +

    Properties

    @@ -1078,11 +1126,10 @@

    Parameters

    - diff --git a/docs/Classes/MetadataSearchFilter.html b/docs/Classes/MetadataSearchFilter.html index 0c2e50271..189f10f65 100644 --- a/docs/Classes/MetadataSearchFilter.html +++ b/docs/Classes/MetadataSearchFilter.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -900,11 +948,10 @@

    Parameters

    - diff --git a/docs/Classes/MetadataTemplate.html b/docs/Classes/MetadataTemplate.html index 226b1e5db..4d55e9462 100644 --- a/docs/Classes/MetadataTemplate.html +++ b/docs/Classes/MetadataTemplate.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -774,7 +822,7 @@

    MetadataTemplate

    -

    Properties

    +

    Properties

    @@ -1051,11 +1099,10 @@

    Parameters

    - diff --git a/docs/Classes/OAuth2Session.html b/docs/Classes/OAuth2Session.html index 9e075bf61..d12502af6 100644 --- a/docs/Classes/OAuth2Session.html +++ b/docs/Classes/OAuth2Session.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -988,11 +1036,10 @@

    Parameters

    - diff --git a/docs/Classes/Order.html b/docs/Classes/Order.html index 1f0dc8f49..5cc8953e9 100644 --- a/docs/Classes/Order.html +++ b/docs/Classes/Order.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Order

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -926,11 +974,10 @@

    Parameters

    - diff --git a/docs/Classes/PagingIterator.html b/docs/Classes/PagingIterator.html index f36b66585..f79507a40 100644 --- a/docs/Classes/PagingIterator.html +++ b/docs/Classes/PagingIterator.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -848,11 +896,10 @@

    Parameters

    - diff --git a/docs/Classes/PathCollection.html b/docs/Classes/PathCollection.html index de45a7436..235c46c4b 100644 --- a/docs/Classes/PathCollection.html +++ b/docs/Classes/PathCollection.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    PathCollection

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -926,11 +974,10 @@

    Parameters

    - diff --git a/docs/Classes/PollingResult.html b/docs/Classes/PollingResult.html index 16d46ea5a..2e0374cd7 100644 --- a/docs/Classes/PollingResult.html +++ b/docs/Classes/PollingResult.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -803,7 +851,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -918,11 +966,10 @@

    Parameters

    - diff --git a/docs/Classes/PollingURLInfo.html b/docs/Classes/PollingURLInfo.html index b0ca3169e..71a82eda5 100644 --- a/docs/Classes/PollingURLInfo.html +++ b/docs/Classes/PollingURLInfo.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    PollingURLInfo

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -953,11 +1001,10 @@

    Parameters

    - diff --git a/docs/Classes/RecentItem.html b/docs/Classes/RecentItem.html index 7ece8e0c0..171a87f75 100644 --- a/docs/Classes/RecentItem.html +++ b/docs/Classes/RecentItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1026,11 +1074,10 @@

    Parameters

    - diff --git a/docs/Classes/RecentItem/InteractionType.html b/docs/Classes/RecentItem/InteractionType.html index b4faaf6e9..81d8bc71c 100644 --- a/docs/Classes/RecentItem/InteractionType.html +++ b/docs/Classes/RecentItem/InteractionType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -987,11 +1035,10 @@

    Declaration

    - diff --git a/docs/Classes/RecentItemsModule.html b/docs/Classes/RecentItemsModule.html index 042de7cd1..45288a050 100644 --- a/docs/Classes/RecentItemsModule.html +++ b/docs/Classes/RecentItemsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -850,11 +898,10 @@

    Parameters

    - diff --git a/docs/Classes/RetentionPoliciesModule.html b/docs/Classes/RetentionPoliciesModule.html index e061c7b02..78da7b867 100644 --- a/docs/Classes/RetentionPoliciesModule.html +++ b/docs/Classes/RetentionPoliciesModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1433,11 +1481,10 @@

    Return Value

    - diff --git a/docs/Classes/RetentionPolicy.html b/docs/Classes/RetentionPolicy.html index 56055d365..c11a4d35c 100644 --- a/docs/Classes/RetentionPolicy.html +++ b/docs/Classes/RetentionPolicy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1177,11 +1225,10 @@

    Declaration

    - diff --git a/docs/Classes/RetentionPolicyAssignment.html b/docs/Classes/RetentionPolicyAssignment.html index 9710f9a24..f21e9aa5c 100644 --- a/docs/Classes/RetentionPolicyAssignment.html +++ b/docs/Classes/RetentionPolicyAssignment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1015,11 +1063,10 @@

    Declaration

    - diff --git a/docs/Classes/RetentionPolicyAssignmentItem.html b/docs/Classes/RetentionPolicyAssignmentItem.html index 35e11331d..93ddb7636 100644 --- a/docs/Classes/RetentionPolicyAssignmentItem.html +++ b/docs/Classes/RetentionPolicyAssignmentItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    RetentionPolicyAssignmentItem

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/Classes/RetentionPolicyEntry.html b/docs/Classes/RetentionPolicyEntry.html index 167083c5d..44f71f75c 100644 --- a/docs/Classes/RetentionPolicyEntry.html +++ b/docs/Classes/RetentionPolicyEntry.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/Classes/Scope.html b/docs/Classes/Scope.html index c7e674371..906c85959 100644 --- a/docs/Classes/Scope.html +++ b/docs/Classes/Scope.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Scope

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -926,11 +974,10 @@

    Parameters

    - diff --git a/docs/Classes/SearchModule.html b/docs/Classes/SearchModule.html index 7bc81ec4d..0645eb498 100644 --- a/docs/Classes/SearchModule.html +++ b/docs/Classes/SearchModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1315,11 +1363,10 @@

    Parameters

    - diff --git a/docs/Classes/SearchResult.html b/docs/Classes/SearchResult.html index 8c2f554eb..434c6fd72 100644 --- a/docs/Classes/SearchResult.html +++ b/docs/Classes/SearchResult.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    SearchResult

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -954,11 +1002,10 @@

    Parameters

    - diff --git a/docs/Classes/SharedItem.html b/docs/Classes/SharedItem.html index 785bd6855..35eab86d9 100644 --- a/docs/Classes/SharedItem.html +++ b/docs/Classes/SharedItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    SharedItem

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/Classes/SharedItem/SharedItemType.html b/docs/Classes/SharedItem/SharedItemType.html index 33b823c03..0f2b88542 100644 --- a/docs/Classes/SharedItem/SharedItemType.html +++ b/docs/Classes/SharedItem/SharedItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/Classes/SharedItemsModule.html b/docs/Classes/SharedItemsModule.html index 6213bb9ae..6a6bf3011 100644 --- a/docs/Classes/SharedItemsModule.html +++ b/docs/Classes/SharedItemsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -860,11 +908,10 @@

    Parameters

    - diff --git a/docs/Classes/SharedLink.html b/docs/Classes/SharedLink.html index 3d2e15407..74208f1a4 100644 --- a/docs/Classes/SharedLink.html +++ b/docs/Classes/SharedLink.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -843,7 +891,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1205,11 +1253,10 @@

    Parameters

    - diff --git a/docs/Classes/SharedLink/Permissions.html b/docs/Classes/SharedLink/Permissions.html index fbc28af08..38752ed22 100644 --- a/docs/Classes/SharedLink/Permissions.html +++ b/docs/Classes/SharedLink/Permissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/Classes/SignRequest.html b/docs/Classes/SignRequest.html new file mode 100644 index 000000000..70d21fa24 --- /dev/null +++ b/docs/Classes/SignRequest.html @@ -0,0 +1,1423 @@ + + + + SignRequest Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequest

    +
    +
    + +
    public class SignRequest : BoxModel
    + +
    +
    +

    A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

    + +
    +
    +
    +
    + + +
    + +

    BoxModel +

    +
    +
    +
      +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Box item type

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var type: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + signers + +
      +
      +
      +
      +
      +
      +

      Signers for the sign request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let signers: [SignRequestSigner]
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      Sign request ID

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let id: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + prepareUrl + +
      +
      +
      +
      +
      +
      +

      This URL is returned if isDocumentPreparationNeeded is set to true in the request. +It is used to prepare the sign request via UI. +The sign request is not sent until preparation is complete.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let prepareUrl: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + signingLog + +
      +
      +
      +
      +
      +
      +

      Reference to a file that holds a log of all signer activity for the request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let signingLog: File?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + status + +
      +
      +
      +
      +
      +
      +

      Status of the sign request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let status: SignRequestStatus?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + signFiles + +
      +
      +
      +
      +
      +
      +

      List of files that will be signed, which are copies of the original source files. +A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let signFiles: SignRequestSignFiles?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + autoExpireAt + +
      +
      +
      +
      +
      +
      +

      Uses daysValid to calculate the date and time, the sign request will expire if unsigned.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let autoExpireAt: Date?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isDocumentPreparationNeeded: Bool?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Disables the usage of signatures generated by typing (text). Default is true.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let areTextSignaturesEnabled: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + emailSubject + +
      +
      +
      +
      +
      +
      +

      Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let emailSubject: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + emailMessage + +
      +
      +
      +
      +
      +
      +

      Message to include in sign request email. The field is cleaned through sanitization of specific characters. +However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. +The message may contain the following html tags including : +a, abbr, acronym, b, blockquote, code, em, i, ul, li, ol, and strong. +Be aware that when the text to html ratio is too high, the email may end up in spam filters. +Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let emailMessage: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + areRemindersEnabled + +
      +
      +
      +
      +
      +
      +

      Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let areRemindersEnabled: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + sourceFiles + +
      +
      +
      +
      +
      +
      +

      List of files to create a signing document from.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let sourceFiles: [File]
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + parentFolder + +
      +
      +
      +
      +
      +
      +

      The destination folder to place final, signed document and signing log.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let parentFolder: Folder
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + prefillTags + +
      +
      +
      +
      +
      +
      +

      List of prefill tags.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let prefillTags: [SignRequestPrefillTag]?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + daysValid + +
      +
      +
      +
      +
      +
      +

      Number of days after which this request will automatically expire if not completed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let daysValid: Int?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + externalId + +
      +
      +
      +
      +
      +
      +

      A reference ID in an external system that the sign request is related to.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let externalId: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/SignRequestPrefillTag.html b/docs/Classes/SignRequestPrefillTag.html new file mode 100644 index 000000000..617c9ee58 --- /dev/null +++ b/docs/Classes/SignRequestPrefillTag.html @@ -0,0 +1,1129 @@ + + + + SignRequestPrefillTag Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestPrefillTag

    +
    +
    + +
    public class SignRequestPrefillTag : BoxInnerModel
    + +
    +
    +

    Prefill tags are used to prefill placeholders with signer input data. +Only one value field can be included.

    + +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + documentTagId + +
      +
      +
      +
      +
      +
      +

      This references the ID of a specific tag contained in a file of the sign request

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let documentTagId: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + textValue + +
      +
      +
      +
      +
      +
      +

      Text prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let textValue: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + checkboxValue + +
      +
      +
      +
      +
      +
      +

      Checkbox prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let checkboxValue: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + dateValue + +
      +
      +
      +
      +
      +
      +

      Date prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let dateValue: Date?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    documentTagId: String?,
      +    textValue: String?
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + documentTagId + + +
      +

      Id of the tag.

      +
      +
      + + textValue + + +
      +

      The text prefill value.

      +
      +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    documentTagId: String?,
      +    checkboxValue: Bool?
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + documentTagId + + +
      +

      Id of the tag.

      +
      +
      + + checkboxValue + + +
      +

      The checkbox prefill value.

      +
      +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    documentTagId: String?,
      +    dateValue: Date?
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + documentTagId + + +
      +

      Id of the tag.

      +
      +
      + + dateValue + + +
      +

      The date prefill value.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/SignRequestSignFiles.html b/docs/Classes/SignRequestSignFiles.html new file mode 100644 index 000000000..a95d65067 --- /dev/null +++ b/docs/Classes/SignRequestSignFiles.html @@ -0,0 +1,986 @@ + + + + SignRequestSignFiles Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignFiles

    +
    +
    + +
    public class SignRequestSignFiles : BoxModel
    + +
    +
    +

    List of files that will be signed, which are copies of the original source files. +A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

    + +
    +
    +
    +
    + + +
    + +

    BoxModel +

    +
    +
    +
      +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + files + +
      +
      +
      +
      +
      +
      +

      Files that signing events will occur on - these are copies of the original source files.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let files: [File]?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + isReadyForDownload + +
      +
      +
      +
      +
      +
      +

      Indicates whether the signFiles documents are processing and the PDFs may be out of date. +A change to any document requires processing on all signFiles. +We recommended waiting until processing is finished (and this value is true) before downloading the PDFs.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isReadyForDownload: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/SignRequestSigner.html b/docs/Classes/SignRequestSigner.html new file mode 100644 index 000000000..8da152899 --- /dev/null +++ b/docs/Classes/SignRequestSigner.html @@ -0,0 +1,1172 @@ + + + + SignRequestSigner Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSigner

    +
    +
    + +
    public class SignRequestSigner : BoxModel
    + +
    +
    +

    Represents a signer fields for GET Sign Request response.

    + +
    +
    +
    +
    + + +
    + +

    BoxModel +

    +
    +
    +
      +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + email + +
      +
      +
      +
      +
      +
      +

      Email address of the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let email: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + role + +
      +
      +
      +
      +
      +
      +

      Role of the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let role: SignRequestSignerRole?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + isInPerson + +
      +
      +
      +
      +
      +
      +

      Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isInPerson: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + order + +
      +
      +
      +
      +
      +
      +

      Order of the signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let order: Int?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      User ID for the signer in an external application responsible for authentication when accessing the embed URL.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let embedUrlExternalUserId: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + hasViewedDocument + +
      +
      +
      +
      +
      +
      +

      Flag which indicating if signer has viewed the document.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let hasViewedDocument: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + signerDecision + +
      +
      +
      +
      +
      +
      +

      Final decision made by the signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let signerDecision: SignRequestSignerDecision?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + inputs + +
      +
      +
      +
      +
      +
      +

      Inputs created by a signer on a sign request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let inputs: [SignRequestSignerInput]?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + embedUrl + +
      +
      +
      +
      +
      +
      +

      URL to direct a signer to for signing.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let embedUrl: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/SignRequestSignerDecision.html b/docs/Classes/SignRequestSignerDecision.html new file mode 100644 index 000000000..3b9fed9ea --- /dev/null +++ b/docs/Classes/SignRequestSignerDecision.html @@ -0,0 +1,983 @@ + + + + SignRequestSignerDecision Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerDecision

    +
    +
    + +
    public class SignRequestSignerDecision : BoxModel
    + +
    +
    +

    Final decision made by the signer

    + +
    +
    +
    +
    + + +
    + +

    BoxModel +

    +
    +
    +
      +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Type of decision made by the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let type: SignRequestSignerDecisionType?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + finalizedAt + +
      +
      +
      +
      +
      +
      +

      Date and Time that the decision was made

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let finalizedAt: Date?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/SignRequestSignerInput.html b/docs/Classes/SignRequestSignerInput.html new file mode 100644 index 000000000..c918e4ab0 --- /dev/null +++ b/docs/Classes/SignRequestSignerInput.html @@ -0,0 +1,1078 @@ + + + + SignRequestSignerInput Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerInput

    +
    +
    + +
    public class SignRequestSignerInput : BoxModel
    + +
    +
    +

    Prefill tags are used to prefill placeholders with signer input data. Only none value field can be included.

    + +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Type of input

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let type: SignRequestSignerInputType?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + pageIndex + +
      +
      +
      +
      +
      +
      +

      Index of page that the input is on

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let pageIndex: Int
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + documentTagId + +
      +
      +
      +
      +
      +
      +

      This references the ID of a specific tag contained in a file of the sign request

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let documentTagId: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + textValue + +
      +
      +
      +
      +
      +
      +

      Text prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let textValue: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + checkboxValue + +
      +
      +
      +
      +
      +
      +

      Checkbox prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let checkboxValue: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + dateValue + +
      +
      +
      +
      +
      +
      +

      Date prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let dateValue: Date?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/SignRequestsModule.html b/docs/Classes/SignRequestsModule.html new file mode 100644 index 000000000..546c8aa0c --- /dev/null +++ b/docs/Classes/SignRequestsModule.html @@ -0,0 +1,1182 @@ + + + + SignRequestsModule Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestsModule

    +
    +
    + +
    public class SignRequestsModule
    + +
    +
    +

    Provides management of Sign Requests

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Creates a sign request. This involves preparing a document for signing and sending the sign request to signers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func create(
      +    signers: [SignRequestCreateSigner],
      +    sourceFiles: [SignRequestCreateSourceFile],
      +    parentFolder: SignRequestCreateParentFolder,
      +    parameters: SignRequestCreateParameters? = nil,
      +    completion: @escaping Callback<SignRequest>
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + +
      + + signers + + +
      +

      List of signers for the sign request. 35 is the max number of signers permitted.

      +
      +
      + + sourceFiles + + +
      +

      List of files to create a signing document from.

      +
      +
      + + parentFolder + + +
      +

      The destination folder to place final, signed document and signing log. +The root folder, folder ID 0, cannot be used.

      +
      +
      + + parameters + + +
      +

      The optional parameters.

      +
      +
      + + completion + + +
      +

      Returns a SignRequest response object if successful otherwise a BoxSDKError.

      +
      +
      +
      +
      +
      +
    • +
    • +
      + + + + list(marker:limit:) + +
      +
      +
      +
      +
      +
      +

      List all sign requests.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func list(
      +    marker: String? = nil,
      +    limit: Int? = nil
      +) -> PagingIterator<SignRequest>
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + marker + + +
      +

      The position marker at which to begin the response. See marker-based paging for details.

      +
      +
      + + limit + + +
      +

      The maximum number of items to return.

      +
      +
      +
      +
      +

      Return Value

      +

      Returns a pagination iterator to fetch SignRequest items.

      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Get sign request by ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func getById(
      +    id: String,
      +    completion: @escaping Callback<SignRequest>
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + id + + +
      +

      The ID of the sign request.

      +
      +
      + + completion + + +
      +

      Returns a SignRequest response object if successful otherwise a BoxSDKError.

      +
      +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Resends a sign request email to all outstanding signers. +There is a 10 minute cooling-off period between each resend request. +If you make a resend call during the cooling-off period, a BoxAPIError will be thrown.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func resendById(
      +    id: String,
      +    completion: @escaping Callback<Void>
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + id + + +
      +

      The ID of the sign request.

      +
      +
      + + completion + + +
      +

      Returns an empty response if successful otherwise a BoxSDKError.

      +
      +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Cancels a sign request if it has not yet been signed or declined. +Any outstanding signers will no longer be able to sign the document.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func cancelById(
      +    id: String,
      +    completion: @escaping Callback<SignRequest>
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + id + + +
      +

      The ID of the sign request.

      +
      +
      + + completion + + +
      +

      Returns a cancelled SignRequest response object if successful otherwise a BoxSDKError.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Classes/SingleTokenSession.html b/docs/Classes/SingleTokenSession.html index 76ea75727..8eb249e09 100644 --- a/docs/Classes/SingleTokenSession.html +++ b/docs/Classes/SingleTokenSession.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -912,11 +960,10 @@

    Parameters

    - diff --git a/docs/Classes/StoragePoliciesModule.html b/docs/Classes/StoragePoliciesModule.html index a3d881a16..f0910547e 100644 --- a/docs/Classes/StoragePoliciesModule.html +++ b/docs/Classes/StoragePoliciesModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1434,11 +1482,10 @@

    Parameters

    - diff --git a/docs/Classes/StoragePolicy.html b/docs/Classes/StoragePolicy.html index cdd4bae15..b7f1348c2 100644 --- a/docs/Classes/StoragePolicy.html +++ b/docs/Classes/StoragePolicy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    StoragePolicy

    -

    Properties

    +

    Properties

    @@ -940,11 +988,10 @@

    Parameters

    - diff --git a/docs/Classes/StoragePolicyAssignment.html b/docs/Classes/StoragePolicyAssignment.html index 49cc77a77..d190ce40b 100644 --- a/docs/Classes/StoragePolicyAssignment.html +++ b/docs/Classes/StoragePolicyAssignment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -999,11 +1047,10 @@

    Parameters

    - diff --git a/docs/Classes/StoragePolicyAssignment/AssignedTo.html b/docs/Classes/StoragePolicyAssignment/AssignedTo.html index d64be221a..4a362a42f 100644 --- a/docs/Classes/StoragePolicyAssignment/AssignedTo.html +++ b/docs/Classes/StoragePolicyAssignment/AssignedTo.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/Classes/Task.html b/docs/Classes/Task.html index bb583a4b1..7ef58a1b9 100644 --- a/docs/Classes/Task.html +++ b/docs/Classes/Task.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    Task

    -

    BoxModel

    +

    BoxModel

    @@ -839,7 +887,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1170,11 +1218,10 @@

    Parameters

    - diff --git a/docs/Classes/TaskAssignment.html b/docs/Classes/TaskAssignment.html index ff654889c..abcf173ce 100644 --- a/docs/Classes/TaskAssignment.html +++ b/docs/Classes/TaskAssignment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    TaskAssignment

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1115,11 +1163,10 @@

    Parameters

    - diff --git a/docs/Classes/TasksModule.html b/docs/Classes/TasksModule.html index f488e3396..3f69c9378 100644 --- a/docs/Classes/TasksModule.html +++ b/docs/Classes/TasksModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    TasksModule

    -

    Tasks

    +

    Tasks

    @@ -1177,7 +1225,7 @@

    Parameters

    -

    Task Assignments

    +

    Task Assignments

    @@ -1653,11 +1701,10 @@

    Parameters

    - diff --git a/docs/Classes/TermsOfService.html b/docs/Classes/TermsOfService.html index 4cb861483..3fb736b23 100644 --- a/docs/Classes/TermsOfService.html +++ b/docs/Classes/TermsOfService.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    TermsOfService

    -

    BoxModel

    +

    BoxModel

    @@ -839,7 +887,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1089,11 +1137,10 @@

    Parameters

    - diff --git a/docs/Classes/TermsOfServiceUserStatus.html b/docs/Classes/TermsOfServiceUserStatus.html index e55d4f5d1..d52f5dd07 100644 --- a/docs/Classes/TermsOfServiceUserStatus.html +++ b/docs/Classes/TermsOfServiceUserStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    TermsOfServiceUserStatus

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1061,11 +1109,10 @@

    Parameters

    - diff --git a/docs/Classes/TermsOfServicesModule.html b/docs/Classes/TermsOfServicesModule.html index 341a70e53..8d745d5a5 100644 --- a/docs/Classes/TermsOfServicesModule.html +++ b/docs/Classes/TermsOfServicesModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1402,11 +1450,10 @@

    Parameters

    - diff --git a/docs/Classes/Token.html b/docs/Classes/Token.html index 4cb1848ce..d1535bea8 100644 --- a/docs/Classes/Token.html +++ b/docs/Classes/Token.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Token

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -980,11 +1028,10 @@

    Parameters

    - diff --git a/docs/Classes/TokenInfo.html b/docs/Classes/TokenInfo.html index fe4a51592..3d619abf7 100644 --- a/docs/Classes/TokenInfo.html +++ b/docs/Classes/TokenInfo.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    TokenInfo

    -

    Properties

    +

    Properties

    @@ -1011,11 +1059,10 @@

    Return Value

    - diff --git a/docs/Classes/TrackingCode.html b/docs/Classes/TrackingCode.html index abd7bbc96..5e4898982 100644 --- a/docs/Classes/TrackingCode.html +++ b/docs/Classes/TrackingCode.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -758,7 +806,8 @@

    TrackingCode

    -
    public class TrackingCode : BoxModel
    +
    @available(*, deprecated, message: "This class is obsoleted and will be removed. Please use User.TrackingCode instead.")
    +public class TrackingCode : BoxModel
    @@ -772,7 +821,7 @@

    TrackingCode

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +860,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -926,11 +975,10 @@

    Parameters

    - diff --git a/docs/Classes/TrashModule.html b/docs/Classes/TrashModule.html index 21841270b..438ce77b5 100644 --- a/docs/Classes/TrashModule.html +++ b/docs/Classes/TrashModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1583,11 +1631,10 @@

    Parameters

    - diff --git a/docs/Classes/UploadPart.html b/docs/Classes/UploadPart.html index 65db3cfbd..f296b11d5 100644 --- a/docs/Classes/UploadPart.html +++ b/docs/Classes/UploadPart.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -890,11 +938,10 @@

    Parameters

    - diff --git a/docs/Classes/UploadSession.html b/docs/Classes/UploadSession.html index 085a801cf..200bcfb7f 100644 --- a/docs/Classes/UploadSession.html +++ b/docs/Classes/UploadSession.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -857,7 +905,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1081,11 +1129,10 @@

    Parameters

    - diff --git a/docs/Classes/UploadSession/UploadSessionEndpoints.html b/docs/Classes/UploadSession/UploadSessionEndpoints.html index 9dd62a923..085924c76 100644 --- a/docs/Classes/UploadSession/UploadSessionEndpoints.html +++ b/docs/Classes/UploadSession/UploadSessionEndpoints.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -935,11 +983,10 @@

    Declaration

    - diff --git a/docs/Classes/User.html b/docs/Classes/User.html index e5590033f..9af3f07f7 100644 --- a/docs/Classes/User.html +++ b/docs/Classes/User.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1660,11 +1708,10 @@

    Parameters

    - diff --git a/docs/Classes/User/TrackingCode.html b/docs/Classes/User/TrackingCode.html index bb63d9048..931f51fc8 100644 --- a/docs/Classes/User/TrackingCode.html +++ b/docs/Classes/User/TrackingCode.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/Classes/UsersModule.html b/docs/Classes/UsersModule.html index b705dbc86..2e49340e1 100644 --- a/docs/Classes/UsersModule.html +++ b/docs/Classes/UsersModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -2522,11 +2570,10 @@

    Parameters

    - diff --git a/docs/Classes/Watermark.html b/docs/Classes/Watermark.html index 0ca99c7ba..01513632a 100644 --- a/docs/Classes/Watermark.html +++ b/docs/Classes/Watermark.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -884,7 +932,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -999,11 +1047,10 @@

    Parameters

    - diff --git a/docs/Classes/WebLink.html b/docs/Classes/WebLink.html index b4119b3b6..1227f18cb 100644 --- a/docs/Classes/WebLink.html +++ b/docs/Classes/WebLink.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1417,11 +1465,10 @@

    Parameters

    - diff --git a/docs/Classes/WebLink/Permissions.html b/docs/Classes/WebLink/Permissions.html index 88983d83b..f13c84602 100644 --- a/docs/Classes/WebLink/Permissions.html +++ b/docs/Classes/WebLink/Permissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/Classes/WebLinksModule.html b/docs/Classes/WebLinksModule.html index 4718c2a11..2a25f5ad5 100644 --- a/docs/Classes/WebLinksModule.html +++ b/docs/Classes/WebLinksModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1411,11 +1459,10 @@

    Parameters

    - diff --git a/docs/Classes/Webhook.html b/docs/Classes/Webhook.html index c040acdbd..ba8dd275b 100644 --- a/docs/Classes/Webhook.html +++ b/docs/Classes/Webhook.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1093,11 +1141,10 @@

    Parameters

    - diff --git a/docs/Classes/Webhook/EventTriggers.html b/docs/Classes/Webhook/EventTriggers.html index 1a3303338..40756cee3 100644 --- a/docs/Classes/Webhook/EventTriggers.html +++ b/docs/Classes/Webhook/EventTriggers.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1824,11 +1872,10 @@

    Declaration

    - diff --git a/docs/Classes/WebhooksModule.html b/docs/Classes/WebhooksModule.html index 6ed549d9e..8475da60b 100644 --- a/docs/Classes/WebhooksModule.html +++ b/docs/Classes/WebhooksModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1203,11 +1251,10 @@

    Parameters

    - diff --git a/docs/Classes/ZipDownload.html b/docs/Classes/ZipDownload.html index dfce7d00b..f8f57e629 100644 --- a/docs/Classes/ZipDownload.html +++ b/docs/Classes/ZipDownload.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownload

    -

    Properties

    +

    Properties

    @@ -967,11 +1015,10 @@

    Parameters

    - diff --git a/docs/Classes/ZipDownloadConflict.html b/docs/Classes/ZipDownloadConflict.html index 6b8ecb215..37eaba33d 100644 --- a/docs/Classes/ZipDownloadConflict.html +++ b/docs/Classes/ZipDownloadConflict.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownloadConflict

    -

    Properties

    +

    Properties

    @@ -886,11 +934,10 @@

    Parameters

    - diff --git a/docs/Classes/ZipDownloadConflictItem.html b/docs/Classes/ZipDownloadConflictItem.html index 9e0cd5de0..20267e585 100644 --- a/docs/Classes/ZipDownloadConflictItem.html +++ b/docs/Classes/ZipDownloadConflictItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownloadConflictItem

    -

    Properties

    +

    Properties

    @@ -967,11 +1015,10 @@

    Parameters

    - diff --git a/docs/Classes/ZipDownloadStatus.html b/docs/Classes/ZipDownloadStatus.html index a771cd663..6bfb196db 100644 --- a/docs/Classes/ZipDownloadStatus.html +++ b/docs/Classes/ZipDownloadStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownloadStatus

    -

    Properties

    +

    Properties

    @@ -1021,11 +1069,10 @@

    Parameters

    - diff --git a/docs/Enums.html b/docs/Enums.html index f4dc26a69..4de162528 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -2031,6 +2079,118 @@

    Declaration

    +
  • +
    + + + + SignRequestStatus + +
    +
    +
    +
    +
    +
    +

    Describes the status of the sign request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum SignRequestStatus : BoxEnum
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestSignerRole + +
    +
    +
    +
    +
    +
    +

    Defines the role of the signer in the sign request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum SignRequestSignerRole : BoxEnum
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Type of decision made by the signer

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum SignRequestSignerDecisionType : BoxEnum
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Represents a type of input.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum SignRequestSignerInputType : BoxEnum
    + +
    +
    +
    +
    +
  • @@ -2206,11 +2366,10 @@

    Declaration

    - diff --git a/docs/Enums/AccessibleBy.html b/docs/Enums/AccessibleBy.html index 4259cb091..464d1393c 100644 --- a/docs/Enums/AccessibleBy.html +++ b/docs/Enums/AccessibleBy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/Enums/AssignmentState.html b/docs/Enums/AssignmentState.html index 07917b011..683efeefc 100644 --- a/docs/Enums/AssignmentState.html +++ b/docs/Enums/AssignmentState.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -960,11 +1008,10 @@

    Declaration

    - diff --git a/docs/Enums/AssignmentStatus.html b/docs/Enums/AssignmentStatus.html index 2af527507..beec518bb 100644 --- a/docs/Enums/AssignmentStatus.html +++ b/docs/Enums/AssignmentStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -960,11 +1008,10 @@

    Declaration

    - diff --git a/docs/Enums/BoxSDKErrorEnum.html b/docs/Enums/BoxSDKErrorEnum.html index 3fdae4ed4..1cfcfe81a 100644 --- a/docs/Enums/BoxSDKErrorEnum.html +++ b/docs/Enums/BoxSDKErrorEnum.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1500,11 +1548,10 @@

    Declaration

    - diff --git a/docs/Enums/CollaborationDirection.html b/docs/Enums/CollaborationDirection.html index 65489637a..ee0fe0492 100644 --- a/docs/Enums/CollaborationDirection.html +++ b/docs/Enums/CollaborationDirection.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -933,11 +981,10 @@

    Declaration

    - diff --git a/docs/Enums/CollaborationItem.html b/docs/Enums/CollaborationItem.html index 3d411bbb3..bc7ff920a 100644 --- a/docs/Enums/CollaborationItem.html +++ b/docs/Enums/CollaborationItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    CollaborationItem

    -

    BoxModel

    +

    BoxModel

    @@ -941,11 +989,10 @@

    Declaration

    - diff --git a/docs/Enums/CollaborationRole.html b/docs/Enums/CollaborationRole.html index e5f5b1242..8b87f0d24 100644 --- a/docs/Enums/CollaborationRole.html +++ b/docs/Enums/CollaborationRole.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1089,11 +1137,10 @@

    Declaration

    - diff --git a/docs/Enums/CollaborationStatus.html b/docs/Enums/CollaborationStatus.html index 77f93c0d6..99c46bbf2 100644 --- a/docs/Enums/CollaborationStatus.html +++ b/docs/Enums/CollaborationStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/Enums/CommentItem.html b/docs/Enums/CommentItem.html index 94ca89eca..b5e86a9c9 100644 --- a/docs/Enums/CommentItem.html +++ b/docs/Enums/CommentItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    CommentItem

    -

    BoxModel

    +

    BoxModel

    @@ -941,11 +989,10 @@

    Declaration

    - diff --git a/docs/Enums/ConflictResolution.html b/docs/Enums/ConflictResolution.html index 4f7ae725c..cf6eea42e 100644 --- a/docs/Enums/ConflictResolution.html +++ b/docs/Enums/ConflictResolution.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/Enums/DispositionAction.html b/docs/Enums/DispositionAction.html index 7c064f2dc..41b764bb6 100644 --- a/docs/Enums/DispositionAction.html +++ b/docs/Enums/DispositionAction.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/Enums/EventObserverResponse.html b/docs/Enums/EventObserverResponse.html index 9248637b9..b559ba644 100644 --- a/docs/Enums/EventObserverResponse.html +++ b/docs/Enums/EventObserverResponse.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/Enums/EventType.html b/docs/Enums/EventType.html index 03619cdd6..6ba528a40 100644 --- a/docs/Enums/EventType.html +++ b/docs/Enums/EventType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EventType

    -

    User events

    +

    User events

    @@ -1509,9 +1557,9 @@

    Declaration

  • @@ -1526,7 +1574,7 @@

    Declaration

    Declaration

    Swift

    -
    case masterInviteAccepted
    +
    case adminInviteAccepted
    @@ -1536,9 +1584,9 @@

    Declaration

  • @@ -1553,7 +1601,7 @@

    Declaration

    Declaration

    Swift

    -
    case masterInviteRejected
    +
    case adminInviteRejected
    @@ -1676,7 +1724,7 @@

    Declaration

    -

    Enterprise-only events

    +

    Enterprise-only events

    @@ -2869,6 +2917,33 @@

    Declaration

  • +
  • +
    + + + + contentAccessed + +
    +
    +
    +
    +
    +
    +

    A content was accessed by a user.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case contentAccessed
    + +
    +
    +
    +
    +
  • @@ -3763,9 +3838,9 @@

    Declaration

  • @@ -3773,14 +3848,14 @@

    Declaration

    -

    Folders were added to a group in the Admin console.

    +

    A watermarked file was downloaded.

    Declaration

    Swift

    -
    case itemsAddedToGroup
    +
    case watermarkedFileDownloaded
    @@ -3790,9 +3865,9 @@

    Declaration

  • @@ -3800,14 +3875,176 @@

    Declaration

    -

    A watermarked file was downloaded.

    +

    When a JWT application has been authorized or reauthorized

    Declaration

    Swift

    -
    case watermarkedFileDownloaded
    +
    case enterpriseAppAuthorizationUpdated
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A Shield justification is approved

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldJustificationApproved
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shieldAlert + +
    +
    +
    +
    +
    +
    +

    Shield detected an anomalous download, session, location, or malicious content based on enterprise Shield rules

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldAlert
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shieldAccessBlocked + +
    +
    +
    +
    +
    +
    +

    Access to an external collaboration is blocked

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldAccessBlocked
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Access to an external collaboration is blocked due to missing a justification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldBlockedMissingJustification
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shieldInviteBlocked + +
    +
    +
    +
    +
    +
    +

    An invite to externally collaborate is blocked

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldInviteBlocked
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    An invite to externally collaborate is blocked due to missing a justification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldInviteBlockedMissingJustification
    @@ -3822,7 +4059,7 @@

    Declaration

    -

    Custom value

    +

    Custom value

    @@ -3932,11 +4169,10 @@

    Declaration

  • - diff --git a/docs/Enums/FileMetadataOperation.html b/docs/Enums/FileMetadataOperation.html index 56ef0af44..261d78fd1 100644 --- a/docs/Enums/FileMetadataOperation.html +++ b/docs/Enums/FileMetadataOperation.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -966,11 +1014,10 @@

    Return Value

    - diff --git a/docs/Enums/FileRepresentationHint.html b/docs/Enums/FileRepresentationHint.html index 5850e9678..d58ac7994 100644 --- a/docs/Enums/FileRepresentationHint.html +++ b/docs/Enums/FileRepresentationHint.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -987,11 +1035,10 @@

    Declaration

    - diff --git a/docs/Enums/FolderItem.html b/docs/Enums/FolderItem.html index 5316ab74f..be28cf976 100644 --- a/docs/Enums/FolderItem.html +++ b/docs/Enums/FolderItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    FolderItem

    -

    BoxModel

    +

    BoxModel

    @@ -968,11 +1016,10 @@

    Declaration

    - diff --git a/docs/Enums/FolderItemsOrderBy.html b/docs/Enums/FolderItemsOrderBy.html index aa2f461cc..1a01e2451 100644 --- a/docs/Enums/FolderItemsOrderBy.html +++ b/docs/Enums/FolderItemsOrderBy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -988,11 +1036,10 @@

    Declaration

    - diff --git a/docs/Enums/FolderMetadataOperation.html b/docs/Enums/FolderMetadataOperation.html index 1e132b0fe..11b40291c 100644 --- a/docs/Enums/FolderMetadataOperation.html +++ b/docs/Enums/FolderMetadataOperation.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -912,11 +960,10 @@

    Return Value

    - diff --git a/docs/Enums/FolderUploadEmailAccess.html b/docs/Enums/FolderUploadEmailAccess.html index 08f8baa10..982dccff3 100644 --- a/docs/Enums/FolderUploadEmailAccess.html +++ b/docs/Enums/FolderUploadEmailAccess.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/Enums/GroupInvitabilityLevel.html b/docs/Enums/GroupInvitabilityLevel.html index 47f2b52e2..be6251c33 100644 --- a/docs/Enums/GroupInvitabilityLevel.html +++ b/docs/Enums/GroupInvitabilityLevel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Parameters

    - diff --git a/docs/Enums/GroupMemberViewabilityLevel.html b/docs/Enums/GroupMemberViewabilityLevel.html index 1aaa858c9..ebf3df0c1 100644 --- a/docs/Enums/GroupMemberViewabilityLevel.html +++ b/docs/Enums/GroupMemberViewabilityLevel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Parameters

    - diff --git a/docs/Enums/GroupRole.html b/docs/Enums/GroupRole.html index a5e4d68c3..29c24d071 100644 --- a/docs/Enums/GroupRole.html +++ b/docs/Enums/GroupRole.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/Enums/ItemStatus.html b/docs/Enums/ItemStatus.html index 9b95a74a0..8a5fafb9b 100644 --- a/docs/Enums/ItemStatus.html +++ b/docs/Enums/ItemStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -933,11 +981,10 @@

    Declaration

    - diff --git a/docs/Enums/LogCategory.html b/docs/Enums/LogCategory.html index af81f431f..3f273d670 100644 --- a/docs/Enums/LogCategory.html +++ b/docs/Enums/LogCategory.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -909,11 +957,10 @@

    Declaration

    - diff --git a/docs/Enums/LogLevel.html b/docs/Enums/LogLevel.html index 29c671191..51184cd59 100644 --- a/docs/Enums/LogLevel.html +++ b/docs/Enums/LogLevel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -909,11 +957,10 @@

    Declaration

    - diff --git a/docs/Enums/MetadataFilterBound.html b/docs/Enums/MetadataFilterBound.html index 3c6621ab4..9c3f5a7f6 100644 --- a/docs/Enums/MetadataFilterBound.html +++ b/docs/Enums/MetadataFilterBound.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/Enums/MetadataScope.html b/docs/Enums/MetadataScope.html index dcad0496a..248918cf5 100644 --- a/docs/Enums/MetadataScope.html +++ b/docs/Enums/MetadataScope.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -932,11 +980,10 @@

    Declaration

    - diff --git a/docs/Enums/MetadataTemplateOperation.html b/docs/Enums/MetadataTemplateOperation.html index 80d3b1e08..e78d924cd 100644 --- a/docs/Enums/MetadataTemplateOperation.html +++ b/docs/Enums/MetadataTemplateOperation.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1290,11 +1338,10 @@

    Return Value

    - diff --git a/docs/Enums/NullableParameter.html b/docs/Enums/NullableParameter.html index 2fcd57e12..5973fb3f4 100644 --- a/docs/Enums/NullableParameter.html +++ b/docs/Enums/NullableParameter.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -832,7 +880,7 @@

    Declaration

    -

    Available where T: Encodable

    +

    Available where T: Encodable

    @@ -869,11 +917,10 @@

    Declaration

    - diff --git a/docs/Enums/OrderDirection.html b/docs/Enums/OrderDirection.html index f7ce7e5ef..bc6b557fc 100644 --- a/docs/Enums/OrderDirection.html +++ b/docs/Enums/OrderDirection.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/Enums/PagingParameter.html b/docs/Enums/PagingParameter.html index c72cce108..9228ab04e 100644 --- a/docs/Enums/PagingParameter.html +++ b/docs/Enums/PagingParameter.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/Enums/RetentionPolicyAssignmentItemType.html b/docs/Enums/RetentionPolicyAssignmentItemType.html index 96cf3bc46..98a701699 100644 --- a/docs/Enums/RetentionPolicyAssignmentItemType.html +++ b/docs/Enums/RetentionPolicyAssignmentItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -933,11 +981,10 @@

    Declaration

    - diff --git a/docs/Enums/RetentionPolicyStatus.html b/docs/Enums/RetentionPolicyStatus.html index 3599a35df..8726ff353 100644 --- a/docs/Enums/RetentionPolicyStatus.html +++ b/docs/Enums/RetentionPolicyStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -907,11 +955,10 @@

    Declaration

    - diff --git a/docs/Enums/RetentionPolicyType.html b/docs/Enums/RetentionPolicyType.html index c9758a270..40957f723 100644 --- a/docs/Enums/RetentionPolicyType.html +++ b/docs/Enums/RetentionPolicyType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/Enums/SearchContentType.html b/docs/Enums/SearchContentType.html index 0bebdbb2d..85eda1b5b 100644 --- a/docs/Enums/SearchContentType.html +++ b/docs/Enums/SearchContentType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1008,11 +1056,10 @@

    Declaration

    - diff --git a/docs/Enums/SearchItemType.html b/docs/Enums/SearchItemType.html index b41092924..84367fd27 100644 --- a/docs/Enums/SearchItemType.html +++ b/docs/Enums/SearchItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/Enums/SearchScope.html b/docs/Enums/SearchScope.html index aaf59cdc9..98962e5a6 100644 --- a/docs/Enums/SearchScope.html +++ b/docs/Enums/SearchScope.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -928,11 +976,10 @@

    Declaration

    - diff --git a/docs/Enums/SharedLinkAccess.html b/docs/Enums/SharedLinkAccess.html index f0db5fcfb..df05cd2d9 100644 --- a/docs/Enums/SharedLinkAccess.html +++ b/docs/Enums/SharedLinkAccess.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -933,11 +981,10 @@

    Declaration

    - diff --git a/docs/Enums/SignRequestSignerDecisionType.html b/docs/Enums/SignRequestSignerDecisionType.html new file mode 100644 index 000000000..5b05b68d9 --- /dev/null +++ b/docs/Enums/SignRequestSignerDecisionType.html @@ -0,0 +1,963 @@ + + + + SignRequestSignerDecisionType Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerDecisionType

    +
    +
    + +
    public enum SignRequestSignerDecisionType : BoxEnum
    + +
    +
    +

    Type of decision made by the signer

    + +
    +
    +
    +
      +
    • +
      + + + + signed + +
      +
      +
      +
      +
      +
      +

      Signed decision.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case signed
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + declined + +
      +
      +
      +
      +
      +
      +

      Declined decision.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case declined
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + customValue(_:) + +
      +
      +
      +
      +
      +
      +

      A custom value not implemented in this version of SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case customValue(String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(_:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(_ value: String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var description: String { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/SignRequestSignerInputType.html b/docs/Enums/SignRequestSignerInputType.html new file mode 100644 index 000000000..90d40b153 --- /dev/null +++ b/docs/Enums/SignRequestSignerInputType.html @@ -0,0 +1,1017 @@ + + + + SignRequestSignerInputType Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerInputType

    +
    +
    + +
    public enum SignRequestSignerInputType : BoxEnum
    + +
    +
    +

    Represents a type of input.

    + +
    +
    +
    +
      +
    • +
      + + + + signature + +
      +
      +
      +
      +
      +
      +

      Signature input.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case signature
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + date + +
      +
      +
      +
      +
      +
      +

      Date input.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case date
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + text + +
      +
      +
      +
      +
      +
      +

      Text input.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case text
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + checkbox + +
      +
      +
      +
      +
      +
      +

      Checkbox input.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case checkbox
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + customValue(_:) + +
      +
      +
      +
      +
      +
      +

      Custom value for enum values not yet implemented in the SDK

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case customValue(String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(_:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(_ value: String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var description: String { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/SignRequestSignerRole.html b/docs/Enums/SignRequestSignerRole.html new file mode 100644 index 000000000..4b01fdecc --- /dev/null +++ b/docs/Enums/SignRequestSignerRole.html @@ -0,0 +1,990 @@ + + + + SignRequestSignerRole Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerRole

    +
    +
    + +
    public enum SignRequestSignerRole : BoxEnum
    + +
    +
    +

    Defines the role of the signer in the sign request.

    + +
    +
    +
    +
      +
    • +
      + + + + signer + +
      +
      +
      +
      +
      +
      +

      Role needed to sign the document.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case signer
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + approver + +
      +
      +
      +
      +
      +
      +

      Role needed to approve the document.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case approver
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + finalCopyReader + +
      +
      +
      +
      +
      +
      +

      Role which receives the final signded document and signing log.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case finalCopyReader
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + customValue(_:) + +
      +
      +
      +
      +
      +
      +

      Custom value for enum values not yet implemented in the SDK

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case customValue(String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(_:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(_ value: String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var description: String { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/SignRequestStatus.html b/docs/Enums/SignRequestStatus.html new file mode 100644 index 000000000..63b1811b4 --- /dev/null +++ b/docs/Enums/SignRequestStatus.html @@ -0,0 +1,1179 @@ + + + + SignRequestStatus Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestStatus

    +
    +
    + +
    public enum SignRequestStatus : BoxEnum
    + +
    +
    +

    Describes the status of the sign request.

    + +
    +
    +
    +
      +
    • +
      + + + + converting + +
      +
      +
      +
      +
      +
      +

      Converting status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case converting
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + created + +
      +
      +
      +
      +
      +
      +

      Created status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case created
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + sent + +
      +
      +
      +
      +
      +
      +

      Sent status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case sent
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + viewed + +
      +
      +
      +
      +
      +
      +

      Viewed status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case viewed
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + signed + +
      +
      +
      +
      +
      +
      +

      Signed status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case signed
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + cancelled + +
      +
      +
      +
      +
      +
      +

      Cancelled status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case cancelled
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + declined + +
      +
      +
      +
      +
      +
      +

      Declined status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case declined
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + errorConverting + +
      +
      +
      +
      +
      +
      +

      Error converting status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case errorConverting
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + errorSending + +
      +
      +
      +
      +
      +
      +

      Error sending status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case errorSending
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + expired + +
      +
      +
      +
      +
      +
      +

      Expired status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case expired
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + customValue(_:) + +
      +
      +
      +
      +
      +
      +

      Custom value for enum values not yet implemented in the SDK

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case customValue(String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(_:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(_ value: String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var description: String { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Enums/StreamPosition.html b/docs/Enums/StreamPosition.html index a80885e9a..70c9d1c70 100644 --- a/docs/Enums/StreamPosition.html +++ b/docs/Enums/StreamPosition.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/Enums/StreamType.html b/docs/Enums/StreamType.html index fd2209bf1..9fc3c3317 100644 --- a/docs/Enums/StreamType.html +++ b/docs/Enums/StreamType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/Enums/SyncState.html b/docs/Enums/SyncState.html index d597403a1..9cd3d2cf4 100644 --- a/docs/Enums/SyncState.html +++ b/docs/Enums/SyncState.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/Enums/TaskAction.html b/docs/Enums/TaskAction.html index 402fb83d6..15640a22b 100644 --- a/docs/Enums/TaskAction.html +++ b/docs/Enums/TaskAction.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/Enums/TaskCompletionRule.html b/docs/Enums/TaskCompletionRule.html index 2f0619cb3..26942f84e 100644 --- a/docs/Enums/TaskCompletionRule.html +++ b/docs/Enums/TaskCompletionRule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/Enums/TaskItem.html b/docs/Enums/TaskItem.html index 771f6e891..5f11e4768 100644 --- a/docs/Enums/TaskItem.html +++ b/docs/Enums/TaskItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    TaskItem

    -

    BoxModel

    +

    BoxModel

    @@ -913,11 +961,10 @@

    Declaration

    - diff --git a/docs/Enums/TermsOfServiceStatus.html b/docs/Enums/TermsOfServiceStatus.html index c46813145..3c917ba4a 100644 --- a/docs/Enums/TermsOfServiceStatus.html +++ b/docs/Enums/TermsOfServiceStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/Enums/TermsOfServiceType.html b/docs/Enums/TermsOfServiceType.html index 26e3867d5..e90031adb 100644 --- a/docs/Enums/TermsOfServiceType.html +++ b/docs/Enums/TermsOfServiceType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/Enums/ThumbnailExtension.html b/docs/Enums/ThumbnailExtension.html index b67548c3c..a67c269f4 100644 --- a/docs/Enums/ThumbnailExtension.html +++ b/docs/Enums/ThumbnailExtension.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/Enums/TokenScope.html b/docs/Enums/TokenScope.html index f37948b0a..e1a1f35e5 100644 --- a/docs/Enums/TokenScope.html +++ b/docs/Enums/TokenScope.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1252,11 +1300,10 @@

    Declaration

    - diff --git a/docs/Enums/UserRole.html b/docs/Enums/UserRole.html index b42ca91bf..17733c4b9 100644 --- a/docs/Enums/UserRole.html +++ b/docs/Enums/UserRole.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/Enums/UserStatus.html b/docs/Enums/UserStatus.html index 94bd646bc..43e0fc765 100644 --- a/docs/Enums/UserStatus.html +++ b/docs/Enums/UserStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -981,11 +1029,10 @@

    Declaration

    - diff --git a/docs/Enums/WebhookItem.html b/docs/Enums/WebhookItem.html index 2a8785d8f..6b1f0cffc 100644 --- a/docs/Enums/WebhookItem.html +++ b/docs/Enums/WebhookItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    WebhookItem

    -

    BoxModel

    +

    BoxModel

    @@ -940,11 +988,10 @@

    Declaration

    - diff --git a/docs/Extensions.html b/docs/Extensions.html index d30f5a21b..a9242a0aa 100644 --- a/docs/Extensions.html +++ b/docs/Extensions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -955,11 +1003,10 @@

    Declaration

    - diff --git a/docs/Extensions/Array.html b/docs/Extensions/Array.html index 14014c80f..5c8c4e20a 100644 --- a/docs/Extensions/Array.html +++ b/docs/Extensions/Array.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -771,7 +819,7 @@

    Array

    -

    Available where Element: StringProtocol

    +

    Available where Element: StringProtocol

    @@ -808,11 +856,10 @@

    Declaration

    - diff --git a/docs/Extensions/Bool.html b/docs/Extensions/Bool.html index 15fc344b5..27ac429f5 100644 --- a/docs/Extensions/Bool.html +++ b/docs/Extensions/Bool.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/Extensions/Int.html b/docs/Extensions/Int.html index 0b6ab6502..af2d45c83 100644 --- a/docs/Extensions/Int.html +++ b/docs/Extensions/Int.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/Extensions/NSNumber.html b/docs/Extensions/NSNumber.html index 614eca1be..6f4126417 100644 --- a/docs/Extensions/NSNumber.html +++ b/docs/Extensions/NSNumber.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/Extensions/NSString.html b/docs/Extensions/NSString.html index 5f8c97d7b..cd42cdc66 100644 --- a/docs/Extensions/NSString.html +++ b/docs/Extensions/NSString.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/Extensions/Optional.html b/docs/Extensions/Optional.html index 6bdba82af..cb700bae4 100644 --- a/docs/Extensions/Optional.html +++ b/docs/Extensions/Optional.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -771,7 +819,7 @@

    Optional

    -

    Available where Wrapped: QueryParameterConvertible

    +

    Available where Wrapped: QueryParameterConvertible

    @@ -808,11 +856,10 @@

    Declaration

    - diff --git a/docs/Extensions/String.html b/docs/Extensions/String.html index e6b125ea5..4cde02572 100644 --- a/docs/Extensions/String.html +++ b/docs/Extensions/String.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/Protocols.html b/docs/Protocols.html index 04fe83d3c..0a121eb13 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1073,11 +1121,10 @@

    Declaration

    - diff --git a/docs/Protocols/BoxClientProtocol.html b/docs/Protocols/BoxClientProtocol.html index 1037a2c46..f5d7d1538 100644 --- a/docs/Protocols/BoxClientProtocol.html +++ b/docs/Protocols/BoxClientProtocol.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1598,11 +1646,10 @@

    Parameters

    - diff --git a/docs/Protocols/BoxEnum.html b/docs/Protocols/BoxEnum.html index e4ed24f68..5ce5aa8a1 100644 --- a/docs/Protocols/BoxEnum.html +++ b/docs/Protocols/BoxEnum.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -822,7 +870,7 @@

    Parameters

    -

    Equatable

    +

    Equatable

    @@ -965,7 +1013,7 @@

    Return Value

    -

    Encodable

    +

    Encodable

    @@ -1008,7 +1056,7 @@

    Declaration

    -

    QueryParameterConvertible

    +

    QueryParameterConvertible

    @@ -1051,7 +1099,7 @@

    Declaration

    -

    Decodable

    +

    Decodable

    @@ -1091,11 +1139,10 @@

    Declaration

    - diff --git a/docs/Protocols/BoxModel.html b/docs/Protocols/BoxModel.html index ee38da5c1..84c12b999 100644 --- a/docs/Protocols/BoxModel.html +++ b/docs/Protocols/BoxModel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -989,11 +1037,10 @@

    Return Value

    - diff --git a/docs/Protocols/ExpiredTokenHandling.html b/docs/Protocols/ExpiredTokenHandling.html index d3ab1a5ed..f081af7ee 100644 --- a/docs/Protocols/ExpiredTokenHandling.html +++ b/docs/Protocols/ExpiredTokenHandling.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -819,11 +867,10 @@

    Parameters

    - diff --git a/docs/Protocols/LogDestination.html b/docs/Protocols/LogDestination.html index 003601866..ab9b4e6df 100644 --- a/docs/Protocols/LogDestination.html +++ b/docs/Protocols/LogDestination.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -800,11 +848,10 @@

    Declaration

    - diff --git a/docs/Protocols/NetworkAgentProtocol.html b/docs/Protocols/NetworkAgentProtocol.html index 3382ca14d..6fa2dff88 100644 --- a/docs/Protocols/NetworkAgentProtocol.html +++ b/docs/Protocols/NetworkAgentProtocol.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -834,11 +882,10 @@

    Parameters

    - diff --git a/docs/Protocols/QueryParameterConvertible.html b/docs/Protocols/QueryParameterConvertible.html index 8234dcc6c..a314e659b 100644 --- a/docs/Protocols/QueryParameterConvertible.html +++ b/docs/Protocols/QueryParameterConvertible.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -800,11 +848,10 @@

    Declaration

    - diff --git a/docs/Protocols/SessionProtocol.html b/docs/Protocols/SessionProtocol.html index c307cac3f..7c2e1c1c7 100644 --- a/docs/Protocols/SessionProtocol.html +++ b/docs/Protocols/SessionProtocol.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -951,11 +999,10 @@

    Parameters

    - diff --git a/docs/Protocols/TokenRefreshing.html b/docs/Protocols/TokenRefreshing.html index def039f32..ec5b38320 100644 --- a/docs/Protocols/TokenRefreshing.html +++ b/docs/Protocols/TokenRefreshing.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -889,11 +937,10 @@

    Parameters

    - diff --git a/docs/Protocols/TokenStore.html b/docs/Protocols/TokenStore.html index a8406c285..98327de02 100644 --- a/docs/Protocols/TokenStore.html +++ b/docs/Protocols/TokenStore.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -923,11 +971,10 @@

    Parameters

    - diff --git a/docs/Structs.html b/docs/Structs.html index b60ad6b2b..197c4da9e 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -931,6 +979,146 @@

    Declaration

    +
  • + +
    +
    +
    +
    +
    +

    Represents a file version of a file included in a sign request

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateSourceFileVersion : Encodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Represents a file to be included in a sign request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateSourceFile : Encodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Represents a destination folder to place final, signed document and signing log.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateParentFolder : Encodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Defines a signer for Create Sign Request",

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateSigner : Encodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Defines a request to creatre a sign request object.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateParameters : Encodable
    + +
    +
    +
    +
    +
  • @@ -1187,11 +1375,10 @@

    Declaration

    - diff --git a/docs/Structs/BoxRequestDescription.html b/docs/Structs/BoxRequestDescription.html index 8dfc5c7c7..328578bdb 100644 --- a/docs/Structs/BoxRequestDescription.html +++ b/docs/Structs/BoxRequestDescription.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -881,11 +929,10 @@

    Declaration

    - diff --git a/docs/Structs/BoxResponseDescription.html b/docs/Structs/BoxResponseDescription.html index f6d244e80..d3fc177e1 100644 --- a/docs/Structs/BoxResponseDescription.html +++ b/docs/Structs/BoxResponseDescription.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/Structs/BoxSDKConfiguration.html b/docs/Structs/BoxSDKConfiguration.html index 6748fec0c..f3a0ebd00 100644 --- a/docs/Structs/BoxSDKConfiguration.html +++ b/docs/Structs/BoxSDKConfiguration.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1104,11 +1152,10 @@

    Declaration

    - diff --git a/docs/Structs/BoxURLComponents.html b/docs/Structs/BoxURLComponents.html index c0c9d960d..f6f490f72 100644 --- a/docs/Structs/BoxURLComponents.html +++ b/docs/Structs/BoxURLComponents.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/Structs/ClientAnalyticsInfo.html b/docs/Structs/ClientAnalyticsInfo.html index 82032872f..3e67a37e2 100644 --- a/docs/Structs/ClientAnalyticsInfo.html +++ b/docs/Structs/ClientAnalyticsInfo.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -831,11 +879,10 @@

    Parameters

    - diff --git a/docs/Structs/ConfigurablePermissionData.html b/docs/Structs/ConfigurablePermissionData.html index ba089fa88..67b02c81c 100644 --- a/docs/Structs/ConfigurablePermissionData.html +++ b/docs/Structs/ConfigurablePermissionData.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -969,11 +1017,10 @@

    Parameters

    - diff --git a/docs/Structs/FileRepresentation.html b/docs/Structs/FileRepresentation.html index 381f1397f..369f7ada2 100644 --- a/docs/Structs/FileRepresentation.html +++ b/docs/Structs/FileRepresentation.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1027,11 +1075,10 @@

    Declaration

    - diff --git a/docs/Structs/FileRepresentation/Content.html b/docs/Structs/FileRepresentation/Content.html index 72cbf6913..3d533f0bb 100644 --- a/docs/Structs/FileRepresentation/Content.html +++ b/docs/Structs/FileRepresentation/Content.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -803,11 +851,10 @@

    Declaration

    - diff --git a/docs/Structs/FileRepresentation/Info.html b/docs/Structs/FileRepresentation/Info.html index 44cfb7776..aa0e6cdf8 100644 --- a/docs/Structs/FileRepresentation/Info.html +++ b/docs/Structs/FileRepresentation/Info.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,11 +850,10 @@

    Declaration

    - diff --git a/docs/Structs/FileRepresentation/Status.html b/docs/Structs/FileRepresentation/Status.html index 41666609a..dfceb1401 100644 --- a/docs/Structs/FileRepresentation/Status.html +++ b/docs/Structs/FileRepresentation/Status.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -800,11 +848,10 @@

    Declaration

    - diff --git a/docs/Structs/FileRepresentation/StatusEnum.html b/docs/Structs/FileRepresentation/StatusEnum.html index 3c55e812e..48e8b2c6b 100644 --- a/docs/Structs/FileRepresentation/StatusEnum.html +++ b/docs/Structs/FileRepresentation/StatusEnum.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -987,11 +1035,10 @@

    Declaration

    - diff --git a/docs/Structs/LockData.html b/docs/Structs/LockData.html index 88063496a..872f0275a 100644 --- a/docs/Structs/LockData.html +++ b/docs/Structs/LockData.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -831,11 +879,10 @@

    Parameters

    - diff --git a/docs/Structs/MetadataField.html b/docs/Structs/MetadataField.html index cd2151c24..d5138d3d2 100644 --- a/docs/Structs/MetadataField.html +++ b/docs/Structs/MetadataField.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    MetadataField

    -

    Properties

    +

    Properties

    @@ -1097,11 +1145,10 @@

    Parameters

    - diff --git a/docs/Structs/MetadataFieldFilter.html b/docs/Structs/MetadataFieldFilter.html index 0c029eb17..5be77df62 100644 --- a/docs/Structs/MetadataFieldFilter.html +++ b/docs/Structs/MetadataFieldFilter.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    MetadataFieldFilter

    -

    Properties

    +

    Properties

    @@ -897,11 +945,10 @@

    Parameters

    - diff --git a/docs/Structs/MultipartForm.html b/docs/Structs/MultipartForm.html index c803196a3..0d977f981 100644 --- a/docs/Structs/MultipartForm.html +++ b/docs/Structs/MultipartForm.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -952,11 +1000,10 @@

    Parameters

    - diff --git a/docs/Structs/SharedLinkData.html b/docs/Structs/SharedLinkData.html index f219377f3..752081349 100644 --- a/docs/Structs/SharedLinkData.html +++ b/docs/Structs/SharedLinkData.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -972,11 +1020,10 @@

    Parameters

    - diff --git a/docs/Structs/SignRequestCreateParameters.html b/docs/Structs/SignRequestCreateParameters.html new file mode 100644 index 000000000..6ddce81e9 --- /dev/null +++ b/docs/Structs/SignRequestCreateParameters.html @@ -0,0 +1,1192 @@ + + + + SignRequestCreateParameters Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateParameters

    +
    +
    + +
    public struct SignRequestCreateParameters : Encodable
    + +
    +
    +

    Defines a request to creatre a sign request object.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isDocumentPreparationNeeded: Bool?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Disables the usage of signatures generated by typing (text). Default is true.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let areTextSignaturesEnabled: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + emailSubject + +
      +
      +
      +
      +
      +
      +

      Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let emailSubject: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + emailMessage + +
      +
      +
      +
      +
      +
      +

      Message to include in sign request email. The field is cleaned through sanitization of specific characters. +However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. +The message may contain the following html tags including : +a, abbr, acronym, b, blockquote, code, em, i, ul, li, ol, and strong. +Be aware that when the text to html ratio is too high, the email may end up in spam filters. +Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let emailMessage: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + areRemindersEnabled + +
      +
      +
      +
      +
      +
      +

      Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let areRemindersEnabled: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + prefillTags + +
      +
      +
      +
      +
      +
      +

      List of prefill tags. +When a document contains sign related tags in the content, you can prefill them using this prefillTags +by referencing the id of the tag as the externalId field of the prefill tag.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let prefillTags: [SignRequestPrefillTag]?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + daysValid + +
      +
      +
      +
      +
      +
      +

      Number of days after which this request will automatically expire if not completed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let daysValid: Int?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + externalId + +
      +
      +
      +
      +
      +
      +

      This can be used to reference an ID in an external system that the sign request is related to.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let externalId: String?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    isDocumentPreparationNeeded: Bool? = nil,
      +    areTextSignaturesEnabled: Bool? = nil,
      +    emailSubject: String? = nil,
      +    emailMessage: String? = nil,
      +    areRemindersEnabled: Bool? = nil,
      +    prefillTags: [SignRequestPrefillTag]? = nil,
      +    daysValid: Int? = nil,
      +    externalId: String? = nil
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + + isDocumentPreparationNeeded + + +
      +

      Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

      +
      +
      + + areTextSignaturesEnabled + + +
      +

      Disables the usage of signatures generated by typing (text).

      +
      +
      + + emailSubject + + +
      +

      Subject of sign request email.

      +
      +
      + + emailMessage + + +
      +

      Message to include in sign request email.

      +
      +
      + + areRemindersEnabled + + +
      +

      Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18.

      +
      +
      + + prefillTags + + +
      +

      List of prefill tags.

      +
      +
      + + daysValid + + +
      +

      Number of days after which this request will automatically expire if not completed.

      +
      +
      + + externalId + + +
      +

      ID that serve as reference in an external system that the sign request is related to.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Structs/SignRequestCreateParentFolder.html b/docs/Structs/SignRequestCreateParentFolder.html new file mode 100644 index 000000000..9a077c2a7 --- /dev/null +++ b/docs/Structs/SignRequestCreateParentFolder.html @@ -0,0 +1,949 @@ + + + + SignRequestCreateParentFolder Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateParentFolder

    +
    +
    + +
    public struct SignRequestCreateParentFolder : Encodable
    + +
    +
    +

    Represents a destination folder to place final, signed document and signing log.

    + +
    +
    +
    +
      +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      Identifier of the folder

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let id: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(id:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(id: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + id + + +
      +

      Identifier of the folder that will be used as a destination place.

      +
      +
      +
      +
      +
      +
    • +
    • +
      + + + + init(folder:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(folder: Folder)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + folder + + +
      +

      The folder that will be used as a destination place.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Structs/SignRequestCreateSigner.html b/docs/Structs/SignRequestCreateSigner.html new file mode 100644 index 000000000..295407371 --- /dev/null +++ b/docs/Structs/SignRequestCreateSigner.html @@ -0,0 +1,1066 @@ + + + + SignRequestCreateSigner Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateSigner

    +
    +
    + +
    public struct SignRequestCreateSigner : Encodable
    + +
    +
    +

    Defines a signer for Create Sign Request",

    + +
    +
    +
    +
      +
    • +
      + + + + email + +
      +
      +
      +
      +
      +
      +

      Email address of the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let email: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + role + +
      +
      +
      +
      +
      +
      +

      Role of the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let role: SignRequestSignerRole?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + isInPerson + +
      +
      +
      +
      +
      +
      +

      Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isInPerson: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + order + +
      +
      +
      +
      +
      +
      +

      Order of the signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let order: Int?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      User ID for the signer in an external application responsible for authentication when accessing the embed URL.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let embedUrlExternalUserId: String?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    email: String,
      +    role: SignRequestSignerRole? = nil,
      +    isInPerson: Bool? = nil,
      +    order: Int? = nil,
      +    embedUrlExternalUserId: String? = nil
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + +
      + + email + + +
      +

      Email address of the signer.

      +
      +
      + + role + + +
      +

      Role of the signer.

      +
      +
      + + isInPerson + + +
      +

      flag that is used in combination with an embed url for a sender. +After the sender signs, they will be redirected to the next inPerson signer.

      +
      +
      + + order + + +
      +

      Order of the signer.

      +
      +
      + + embedUrlExternalUserId + + +
      +

      User ID for the signer in an external application responsible for authentication when accessing the embed URL.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Structs/SignRequestCreateSourceFile.html b/docs/Structs/SignRequestCreateSourceFile.html new file mode 100644 index 000000000..03485da2c --- /dev/null +++ b/docs/Structs/SignRequestCreateSourceFile.html @@ -0,0 +1,988 @@ + + + + SignRequestCreateSourceFile Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateSourceFile

    +
    +
    + +
    public struct SignRequestCreateSourceFile : Encodable
    + +
    +
    +

    Represents a file to be included in a sign request.

    + +
    +
    +
    +
      +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      Identifier of the file

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let id: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + fileVersion + +
      +
      +
      +
      +
      +
      +

      The version information of the file.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let fileVersion: SignRequestCreateSourceFileVersion?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(id: String, fileVersionId: String? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + id + + +
      +

      Identifier of the file.

      +
      +
      + + fileVersionId + + +
      +

      Identifier of the file version.

      +
      +
      +
      +
      +
      +
    • +
    • +
      + + + + init(file:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(file: File)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + file + + +
      +

      The file that will be included in a sign request.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Structs/SignRequestCreateSourceFileVersion.html b/docs/Structs/SignRequestCreateSourceFileVersion.html new file mode 100644 index 000000000..0734211f0 --- /dev/null +++ b/docs/Structs/SignRequestCreateSourceFileVersion.html @@ -0,0 +1,903 @@ + + + + SignRequestCreateSourceFileVersion Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateSourceFileVersion

    +
    +
    + +
    public struct SignRequestCreateSourceFileVersion : Encodable
    + +
    +
    +

    Represents a file version of a file included in a sign request

    + +
    +
    +
    +
      +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      The ID of the file version object

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let id: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(id:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(id: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + id + + +
      +

      Identifier of the file version.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/Structs/UploadPartDescription.html b/docs/Structs/UploadPartDescription.html index af11ee133..243139cb2 100644 --- a/docs/Structs/UploadPartDescription.html +++ b/docs/Structs/UploadPartDescription.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -981,11 +1029,10 @@

    Declaration

    - diff --git a/docs/Structs/ZipDownloadItem.html b/docs/Structs/ZipDownloadItem.html index ff56393eb..323a36cbd 100644 --- a/docs/Structs/ZipDownloadItem.html +++ b/docs/Structs/ZipDownloadItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownloadItem

    -

    Properties

    +

    Properties

    @@ -897,11 +945,10 @@

    Parameters

    - diff --git a/docs/Typealiases.html b/docs/Typealiases.html index a5c22b6e6..271dab7a5 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -958,11 +1006,10 @@

    Declaration

    - diff --git a/docs/css/highlight.css b/docs/css/highlight.css index d0db0e13b..c170357ce 100644 --- a/docs/css/highlight.css +++ b/docs/css/highlight.css @@ -1,200 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ /* Credit to https://gist.github.com/wataru420/2048287 */ -.highlight { - /* Comment */ - /* Error */ - /* Keyword */ - /* Operator */ - /* Comment.Multiline */ - /* Comment.Preproc */ - /* Comment.Single */ - /* Comment.Special */ - /* Generic.Deleted */ - /* Generic.Deleted.Specific */ - /* Generic.Emph */ - /* Generic.Error */ - /* Generic.Heading */ - /* Generic.Inserted */ - /* Generic.Inserted.Specific */ - /* Generic.Output */ - /* Generic.Prompt */ - /* Generic.Strong */ - /* Generic.Subheading */ - /* Generic.Traceback */ - /* Keyword.Constant */ - /* Keyword.Declaration */ - /* Keyword.Pseudo */ - /* Keyword.Reserved */ - /* Keyword.Type */ - /* Literal.Number */ - /* Literal.String */ - /* Name.Attribute */ - /* Name.Builtin */ - /* Name.Class */ - /* Name.Constant */ - /* Name.Entity */ - /* Name.Exception */ - /* Name.Function */ - /* Name.Namespace */ - /* Name.Tag */ - /* Name.Variable */ - /* Operator.Word */ - /* Text.Whitespace */ - /* Literal.Number.Float */ - /* Literal.Number.Hex */ - /* Literal.Number.Integer */ - /* Literal.Number.Oct */ - /* Literal.String.Backtick */ - /* Literal.String.Char */ - /* Literal.String.Doc */ - /* Literal.String.Double */ - /* Literal.String.Escape */ - /* Literal.String.Heredoc */ - /* Literal.String.Interpol */ - /* Literal.String.Other */ - /* Literal.String.Regex */ - /* Literal.String.Single */ - /* Literal.String.Symbol */ - /* Name.Builtin.Pseudo */ - /* Name.Variable.Class */ - /* Name.Variable.Global */ - /* Name.Variable.Instance */ - /* Literal.Number.Integer.Long */ } - .highlight .c { - color: #999988; - font-style: italic; } - .highlight .err { - color: #a61717; - background-color: #e3d2d2; } - .highlight .k { - color: #000000; - font-weight: bold; } - .highlight .o { - color: #000000; - font-weight: bold; } - .highlight .cm { - color: #999988; - font-style: italic; } - .highlight .cp { - color: #999999; - font-weight: bold; } - .highlight .c1 { - color: #999988; - font-style: italic; } - .highlight .cs { - color: #999999; - font-weight: bold; - font-style: italic; } - .highlight .gd { - color: #000000; - background-color: #ffdddd; } - .highlight .gd .x { - color: #000000; - background-color: #ffaaaa; } - .highlight .ge { - color: #000000; - font-style: italic; } - .highlight .gr { - color: #aa0000; } - .highlight .gh { - color: #999999; } - .highlight .gi { - color: #000000; - background-color: #ddffdd; } - .highlight .gi .x { - color: #000000; - background-color: #aaffaa; } - .highlight .go { - color: #888888; } - .highlight .gp { - color: #555555; } - .highlight .gs { - font-weight: bold; } - .highlight .gu { - color: #aaaaaa; } - .highlight .gt { - color: #aa0000; } - .highlight .kc { - color: #000000; - font-weight: bold; } - .highlight .kd { - color: #000000; - font-weight: bold; } - .highlight .kp { - color: #000000; - font-weight: bold; } - .highlight .kr { - color: #000000; - font-weight: bold; } - .highlight .kt { - color: #445588; } - .highlight .m { - color: #009999; } - .highlight .s { - color: #d14; } - .highlight .na { - color: #008080; } - .highlight .nb { - color: #0086B3; } - .highlight .nc { - color: #445588; - font-weight: bold; } - .highlight .no { - color: #008080; } - .highlight .ni { - color: #800080; } - .highlight .ne { - color: #990000; - font-weight: bold; } - .highlight .nf { - color: #990000; } - .highlight .nn { - color: #555555; } - .highlight .nt { - color: #000080; } - .highlight .nv { - color: #008080; } - .highlight .ow { - color: #000000; - font-weight: bold; } - .highlight .w { - color: #bbbbbb; } - .highlight .mf { - color: #009999; } - .highlight .mh { - color: #009999; } - .highlight .mi { - color: #009999; } - .highlight .mo { - color: #009999; } - .highlight .sb { - color: #d14; } - .highlight .sc { - color: #d14; } - .highlight .sd { - color: #d14; } - .highlight .s2 { - color: #d14; } - .highlight .se { - color: #d14; } - .highlight .sh { - color: #d14; } - .highlight .si { - color: #d14; } - .highlight .sx { - color: #d14; } - .highlight .sr { - color: #009926; } - .highlight .s1 { - color: #d14; } - .highlight .ss { - color: #990073; } - .highlight .bp { - color: #999999; } - .highlight .vc { - color: #008080; } - .highlight .vg { - color: #008080; } - .highlight .vi { - color: #008080; } - .highlight .il { - color: #009999; } +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docs/css/jazzy.css b/docs/css/jazzy.css index 5cdffe99c..2e3871391 100644 --- a/docs/css/jazzy.css +++ b/docs/css/jazzy.css @@ -1,3 +1,7 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td { background: transparent; border: 0; @@ -79,6 +83,18 @@ blockquote { padding: 0 10px; border-left: 4px solid #ccc; } +hr { + height: 1px; + border: none; + background-color: #e2e2e2; } + +.footnote-ref { + display: inline-block; + scroll-margin-top: 70px; } + +.footnote-def { + scroll-margin-top: 70px; } + .content-wrapper { margin: 0 auto; width: 980px; } @@ -92,7 +108,7 @@ header { z-index: 3; } header img { padding-right: 6px; - vertical-align: -4px; + vertical-align: -3px; height: 16px; } header a { color: #fff; } diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes.html index 3cad9d0c4..4acadcaff 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1517,6 +1565,34 @@

    Declaration

    +
  • +
    + + + + SignRequestsModule + +
    +
    +
    +
    +
    +
    +

    Provides management of Sign Requests

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestsModule
    + +
    +
    +
    +
    +
  • @@ -2298,7 +2374,8 @@

    Declaration

    Declaration

    Swift

    -
    public class EventContainer : BoxModel
    +
    @available(*, deprecated, message: "This class is obsoleted and will be removed. Please use EntryContainer<Element> instead.")
    +public class EventContainer : BoxModel
    @@ -3176,6 +3253,176 @@

    Declaration

  • +
  • +
    + + + + SignRequest + +
    +
    +
    +
    +
    +
    +

    A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequest : BoxModel
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestPrefillTag + +
    +
    +
    +
    +
    +
    +

    Prefill tags are used to prefill placeholders with signer input data. +Only one value field can be included.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestPrefillTag : BoxInnerModel
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestSignFiles + +
    +
    +
    +
    +
    +
    +

    List of files that will be signed, which are copies of the original source files. +A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestSignFiles : BoxModel
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestSigner + +
    +
    +
    +
    +
    +
    +

    Represents a signer fields for GET Sign Request response.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestSigner : BoxModel
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Final decision made by the signer

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestSignerDecision : BoxModel
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Prefill tags are used to prefill placeholders with signer input data. Only none value field can be included.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class SignRequestSignerInput : BoxModel
    + +
    +
    +
    +
    +
  • @@ -3424,7 +3671,8 @@

    Declaration

    Declaration

    Swift

    -
    public class TrackingCode : BoxModel
    +
    @available(*, deprecated, message: "This class is obsoleted and will be removed. Please use User.TrackingCode instead.")
    +public class TrackingCode : BoxModel
    @@ -3829,11 +4077,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/AuthModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/AuthModule.html index 28d98e9ae..514b30a01 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/AuthModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/AuthModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1041,11 +1089,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxAPIError.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxAPIError.html index 0d8a1426a..6e9ce5b42 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxAPIError.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxAPIError.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxClient.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxClient.html index 33bd89c21..56e927ef4 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxClient.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxClient.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1039,33 +1087,6 @@

    Declaration

    -
  • - -
    -
    -
    -
    -
    -

    Provides collaborations whitelist functionality (deprecated)

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public private(set) lazy var collaborationWhiteList: CollaborationAllowlistModule { get set }
    - -
    -
    -
    -
    -
  • @@ -1417,6 +1438,33 @@

    Declaration

  • +
  • +
    + + + + signRequests + +
    +
    +
    +
    +
    +
    +

    Provides sign requests functionality.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public private(set) lazy var signRequests: SignRequestsModule { get set }
    + +
    +
    +
    +
    +
  • @@ -1875,7 +1923,7 @@

    Parameters

    -

    BoxClientProtocol methods

    +

    BoxClientProtocol methods

    @@ -2812,11 +2860,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxCollection.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxCollection.html index b11147424..4e800dd82 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxCollection.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxCollection.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -774,7 +822,7 @@

    BoxCollection

    -

    Properties

    +

    Properties

    @@ -970,11 +1018,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxNetworkAgent.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxNetworkAgent.html index b7f5e4108..21e1e5ace 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxNetworkAgent.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxNetworkAgent.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -882,11 +930,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxNetworkTask.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxNetworkTask.html index 9f0bbf19f..a4a56ee7e 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxNetworkTask.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxNetworkTask.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxRequest.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxRequest.html index db2463270..69db54c5f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxRequest.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxRequest.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -801,11 +849,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxRequest/BodyType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxRequest/BodyType.html index f7109c254..faa1ffe4b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxRequest/BodyType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxRequest/BodyType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -935,11 +983,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDK.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDK.html index ec00f78f8..da61dbd54 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDK.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDK.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1176,7 +1224,7 @@

    Parameters

    Declaration

    Swift

    -
    @available(iOS 13.0, *)
    +                          
    @available(iOS 13.0, *)
     public func getOAuth2Client(
         tokenInfo: TokenInfo? = nil,
         tokenStore: TokenStore? = nil,
    @@ -1264,7 +1312,7 @@ 

    Parameters

    Declaration

    Swift

    -
    @available(iOS 11.0, *)
    +                          
    @available(iOS 11.0, *)
     public func getOAuth2Client(
         tokenInfo: TokenInfo? = nil,
         tokenStore: TokenStore? = nil,
    @@ -1327,7 +1375,7 @@ 

    Parameters

    -

    Configuration

    +

    Configuration

    @@ -1467,7 +1515,7 @@

    Parameters

    -

    AuthenticationSession

    +

    AuthenticationSession

    @@ -1528,11 +1576,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDK/Constants.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDK/Constants.html index 9a432f30d..704eaaacd 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDK/Constants.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDK/Constants.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDKError.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDKError.html index b3a05097c..a84d7c367 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDKError.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/BoxSDKError.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -963,11 +1011,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Classification.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Classification.html index 8b1943d88..b6aa93c3f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Classification.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Classification.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Classification

    -

    Properties

    +

    Properties

    @@ -940,11 +988,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration.html index d4fc45fb1..08727183e 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -830,7 +878,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1357,11 +1405,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/AcceptanceRequirementsStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/AcceptanceRequirementsStatus.html index daced37bc..db615734c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/AcceptanceRequirementsStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/AcceptanceRequirementsStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -944,11 +992,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/StrongPasswordRequirement.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/StrongPasswordRequirement.html index 4e1ee3ce1..ec4f00ef8 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/StrongPasswordRequirement.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/StrongPasswordRequirement.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -918,11 +966,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/TermsOfServiceRequirement.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/TermsOfServiceRequirement.html index cdd34b7b6..a63d4bd68 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/TermsOfServiceRequirement.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/TermsOfServiceRequirement.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -917,11 +965,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/TwoFactorAuthenticationRequirement.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/TwoFactorAuthenticationRequirement.html index 9b4156233..ee65bd218 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/TwoFactorAuthenticationRequirement.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaboration/TwoFactorAuthenticationRequirement.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -917,11 +965,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistEntry.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistEntry.html index 8a82be078..c9cb1e99f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistEntry.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistEntry.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    CollaborationAllowlistEntry

    -

    BoxModel

    +

    BoxModel

    @@ -1049,11 +1097,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistExemptTarget.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistExemptTarget.html index c46dd3654..c582e8429 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistExemptTarget.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistExemptTarget.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    CollaborationAllowlistExemptTarget

    -

    BoxModel

    +

    BoxModel

    @@ -1022,11 +1070,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistModule.html index a30515b60..9910d5b1d 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationAllowlistModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1367,11 +1415,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationsModule.html index 7aab9a1af..5152c65a9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollaborationsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1468,11 +1516,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaborator.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaborator.html index 18f6ebe64..1c4b1c6a6 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaborator.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaborator.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Collaborator

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaborator/CollaboratorType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaborator/CollaboratorType.html index 882d5daba..14ba0f48c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaborator/CollaboratorType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Collaborator/CollaboratorType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollectionsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollectionsModule.html index 3bed3d9cf..f928d19db 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollectionsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CollectionsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -990,11 +1038,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Comment.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Comment.html index fa959f457..3c75d320f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Comment.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Comment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    Comment

    -

    Properties

    +

    Properties

    @@ -1104,11 +1152,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CommentsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CommentsModule.html index e19ad186b..bcb8353c5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CommentsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/CommentsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1078,11 +1126,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ConsoleLogDestination.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ConsoleLogDestination.html index 327ad6196..f8ea0519b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ConsoleLogDestination.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ConsoleLogDestination.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -855,11 +903,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DelegatedAuthSession.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DelegatedAuthSession.html index 262ec88e6..fc877c32d 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DelegatedAuthSession.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DelegatedAuthSession.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -952,11 +1000,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DevicePin.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DevicePin.html index fa473a0d5..1d6dac62f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DevicePin.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DevicePin.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    DevicePin

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1034,11 +1082,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DevicePinsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DevicePinsModule.html index b2bc0f620..970bfec5c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DevicePinsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/DevicePinsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -987,11 +1035,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EmailAlias.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EmailAlias.html index 25639fa86..5b185b94b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EmailAlias.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EmailAlias.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EmailAlias

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -980,11 +1028,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Enterprise.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Enterprise.html index acde2ca4d..0db90578b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Enterprise.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Enterprise.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Enterprise

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -953,11 +1001,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EntryContainer.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EntryContainer.html index 861d86421..08a8ecf3a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EntryContainer.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EntryContainer.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EntryContainer

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1061,11 +1109,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EntryContainerInnerModel.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EntryContainerInnerModel.html index c7a128ae1..ce8afd2f9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EntryContainerInnerModel.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EntryContainerInnerModel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EntryContainerInnerModel

    -

    Properties

    +

    Properties

    @@ -809,11 +857,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Event.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Event.html index 482ac39e1..8ce25c689 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Event.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Event.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -829,7 +877,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1107,11 +1155,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventContainer.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventContainer.html index 0907ecd67..afba3b1af 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventContainer.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventContainer.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -758,7 +806,8 @@

    EventContainer

    -
    public class EventContainer : BoxModel
    +
    @available(*, deprecated, message: "This class is obsoleted and will be removed. Please use EntryContainer<Element> instead.")
    +public class EventContainer : BoxModel
    @@ -772,7 +821,7 @@

    EventContainer

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +860,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1007,11 +1056,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventItem.html index a7c5a436c..48eb6311f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EventItem

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventItem/EventItemType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventItem/EventItemType.html index 157604107..b9ac4d203 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventItem/EventItemType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventItem/EventItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventsModule.html index 54a0f1515..2209f3049 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/EventsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1082,11 +1130,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ExpiringEmbedLink.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ExpiringEmbedLink.html index 5f503df1b..89cc70aff 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ExpiringEmbedLink.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ExpiringEmbedLink.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ExpiringEmbedLink

    -

    Properties

    +

    Properties

    @@ -913,11 +961,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/File.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/File.html index a1172e17c..786caf466 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/File.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/File.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1045,7 +1093,7 @@

    Declaration

    Declaration

    Swift

    -
    public let `extension`: String?
    +
    public let `extension`: String?
    @@ -1919,11 +1967,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/File/Permissions.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/File/Permissions.html index b068ccdda..470f3c9dc 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/File/Permissions.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/File/Permissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1097,11 +1145,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileLogDestination.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileLogDestination.html index ab06bc9c4..c5ce8403b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileLogDestination.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileLogDestination.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -901,11 +949,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersion.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersion.html index d3dd60fbd..7dce4ac0c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersion.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersion.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    FileVersion

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1250,11 +1298,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersionLegalHold.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersionLegalHold.html index c391ad241..0b4af903f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersionLegalHold.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersionLegalHold.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    FileVersionLegalHold

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1034,11 +1082,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersionRetention.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersionRetention.html index 3f6ec6910..b5875ea82 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersionRetention.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FileVersionRetention.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    FileVersionRetention

    -

    Properties

    +

    Properties

    @@ -1048,11 +1096,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FilesModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FilesModule.html index b964932e2..cc3fd4091 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FilesModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FilesModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -4824,11 +4872,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Folder.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Folder.html index e7cb41969..581b5f187 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Folder.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Folder.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1768,11 +1816,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Folder/Permissions.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Folder/Permissions.html index e81a9e5c5..a3c71337b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Folder/Permissions.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Folder/Permissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -962,11 +1010,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderLock.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderLock.html index 0ecd85672..29a596360 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderLock.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderLock.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1093,11 +1141,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderLock/LockedOperations.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderLock/LockedOperations.html index 6b3165304..8177f2e8c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderLock/LockedOperations.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderLock/LockedOperations.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderUploadEmail.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderUploadEmail.html index 4e2aa16dd..369325e26 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderUploadEmail.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FolderUploadEmail.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    FolderUploadEmail

    -

    Properties

    +

    Properties

    @@ -836,11 +884,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FoldersModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FoldersModule.html index 2872263ef..ff9403288 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FoldersModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/FoldersModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -2418,11 +2466,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Group.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Group.html index 8aa07f3ab..e7d2ba960 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Group.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Group.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1201,11 +1249,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Group/GroupType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Group/GroupType.html index 56eded29f..0f62d4006 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Group/GroupType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Group/GroupType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupMembership.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupMembership.html index 69d783fdc..a06fe0ae4 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupMembership.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupMembership.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -1107,11 +1155,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupMembership/ConfigurablePermissions.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupMembership/ConfigurablePermissions.html index 64c71dc34..03e46e0c9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupMembership/ConfigurablePermissions.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupMembership/ConfigurablePermissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -881,11 +929,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupsModule.html index 6ea1ed8e9..05fc5e3d4 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/GroupsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1905,11 +1953,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Invite.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Invite.html index 5d8fc27a6..eaad456cf 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Invite.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Invite.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Invite

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1088,11 +1136,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/KeychainTokenStore.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/KeychainTokenStore.html index 66ea33142..03f329ff5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/KeychainTokenStore.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/KeychainTokenStore.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -878,11 +926,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy.html index 0bf2e0067..10d9a028d 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -832,7 +880,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -898,7 +946,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1283,11 +1331,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy/AssignmentCounts.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy/AssignmentCounts.html index 62680a7d4..50d636f61 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy/AssignmentCounts.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy/AssignmentCounts.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -881,11 +929,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy/Status.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy/Status.html index 07776f4c2..28b27528f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy/Status.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicy/Status.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -960,11 +1008,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignment.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignment.html index 174cb0379..67f6e2076 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignment.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    LegalHoldPolicyAssignment

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1061,11 +1109,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignmentItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignmentItem.html index eaa64632f..583f56f76 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignmentItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignmentItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    LegalHoldPolicyAssignmentItem

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html index f8b71c16e..2ec8c838a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -881,11 +929,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldsModule.html index 3661fa416..e9a3c6c21 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/LegalHoldsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1778,11 +1826,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Lock.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Lock.html index 37273e1e1..783bb2f03 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Lock.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Lock.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Lock

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1034,11 +1082,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataCascadePolicy.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataCascadePolicy.html index e9cbc0463..3eedf7ead 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataCascadePolicy.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataCascadePolicy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    MetadataCascadePolicy

    -

    Properties

    +

    Properties

    @@ -1023,11 +1071,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataCascadePolicyModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataCascadePolicyModule.html index 47759536f..446df351c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataCascadePolicyModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataCascadePolicyModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1189,11 +1237,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataModule.html index c446b9592..a58ee38a8 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -2083,11 +2131,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataObject.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataObject.html index ce3ad4708..c96c3a11a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataObject.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataObject.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    MetadataObject

    -

    Properties

    +

    Properties

    @@ -1078,11 +1126,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataSearchFilter.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataSearchFilter.html index 0c2e50271..189f10f65 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataSearchFilter.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataSearchFilter.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -900,11 +948,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataTemplate.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataTemplate.html index 226b1e5db..4d55e9462 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataTemplate.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/MetadataTemplate.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -774,7 +822,7 @@

    MetadataTemplate

    -

    Properties

    +

    Properties

    @@ -1051,11 +1099,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/OAuth2Session.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/OAuth2Session.html index 9e075bf61..d12502af6 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/OAuth2Session.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/OAuth2Session.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -988,11 +1036,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Order.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Order.html index 1f0dc8f49..5cc8953e9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Order.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Order.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Order

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -926,11 +974,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PagingIterator.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PagingIterator.html index f36b66585..f79507a40 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PagingIterator.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PagingIterator.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -848,11 +896,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PathCollection.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PathCollection.html index de45a7436..235c46c4b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PathCollection.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PathCollection.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    PathCollection

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -926,11 +974,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PollingResult.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PollingResult.html index 16d46ea5a..2e0374cd7 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PollingResult.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PollingResult.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -803,7 +851,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -918,11 +966,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PollingURLInfo.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PollingURLInfo.html index b0ca3169e..71a82eda5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PollingURLInfo.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/PollingURLInfo.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    PollingURLInfo

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -953,11 +1001,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItem.html index 7ece8e0c0..171a87f75 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1026,11 +1074,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItem/InteractionType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItem/InteractionType.html index b4faaf6e9..81d8bc71c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItem/InteractionType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItem/InteractionType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -987,11 +1035,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItemsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItemsModule.html index 042de7cd1..45288a050 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItemsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RecentItemsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -850,11 +898,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPoliciesModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPoliciesModule.html index e061c7b02..78da7b867 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPoliciesModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPoliciesModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1433,11 +1481,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicy.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicy.html index 56055d365..c11a4d35c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicy.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1177,11 +1225,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyAssignment.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyAssignment.html index 9710f9a24..f21e9aa5c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyAssignment.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyAssignment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1015,11 +1063,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyAssignmentItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyAssignmentItem.html index 35e11331d..93ddb7636 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyAssignmentItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyAssignmentItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    RetentionPolicyAssignmentItem

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyEntry.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyEntry.html index 167083c5d..44f71f75c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyEntry.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/RetentionPolicyEntry.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Scope.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Scope.html index c7e674371..906c85959 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Scope.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Scope.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Scope

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -926,11 +974,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SearchModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SearchModule.html index 7bc81ec4d..0645eb498 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SearchModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SearchModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1315,11 +1363,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SearchResult.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SearchResult.html index 8c2f554eb..434c6fd72 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SearchResult.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SearchResult.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    SearchResult

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -954,11 +1002,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItem.html index 785bd6855..35eab86d9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    SharedItem

    -

    BoxModel

    +

    BoxModel

    @@ -914,11 +962,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItem/SharedItemType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItem/SharedItemType.html index 33b823c03..0f2b88542 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItem/SharedItemType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItem/SharedItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItemsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItemsModule.html index 6213bb9ae..6a6bf3011 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItemsModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedItemsModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -860,11 +908,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedLink.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedLink.html index 3d2e15407..74208f1a4 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedLink.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedLink.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -843,7 +891,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1205,11 +1253,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedLink/Permissions.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedLink/Permissions.html index fbc28af08..38752ed22 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedLink/Permissions.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SharedLink/Permissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequest.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequest.html new file mode 100644 index 000000000..70d21fa24 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequest.html @@ -0,0 +1,1423 @@ + + + + SignRequest Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequest

    +
    +
    + +
    public class SignRequest : BoxModel
    + +
    +
    +

    A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

    + +
    +
    +
    +
    + + +
    + +

    BoxModel +

    +
    +
    +
      +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Box item type

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var type: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + signers + +
      +
      +
      +
      +
      +
      +

      Signers for the sign request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let signers: [SignRequestSigner]
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      Sign request ID

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let id: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + prepareUrl + +
      +
      +
      +
      +
      +
      +

      This URL is returned if isDocumentPreparationNeeded is set to true in the request. +It is used to prepare the sign request via UI. +The sign request is not sent until preparation is complete.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let prepareUrl: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + signingLog + +
      +
      +
      +
      +
      +
      +

      Reference to a file that holds a log of all signer activity for the request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let signingLog: File?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + status + +
      +
      +
      +
      +
      +
      +

      Status of the sign request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let status: SignRequestStatus?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + signFiles + +
      +
      +
      +
      +
      +
      +

      List of files that will be signed, which are copies of the original source files. +A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let signFiles: SignRequestSignFiles?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + autoExpireAt + +
      +
      +
      +
      +
      +
      +

      Uses daysValid to calculate the date and time, the sign request will expire if unsigned.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let autoExpireAt: Date?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isDocumentPreparationNeeded: Bool?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Disables the usage of signatures generated by typing (text). Default is true.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let areTextSignaturesEnabled: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + emailSubject + +
      +
      +
      +
      +
      +
      +

      Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let emailSubject: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + emailMessage + +
      +
      +
      +
      +
      +
      +

      Message to include in sign request email. The field is cleaned through sanitization of specific characters. +However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. +The message may contain the following html tags including : +a, abbr, acronym, b, blockquote, code, em, i, ul, li, ol, and strong. +Be aware that when the text to html ratio is too high, the email may end up in spam filters. +Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let emailMessage: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + areRemindersEnabled + +
      +
      +
      +
      +
      +
      +

      Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let areRemindersEnabled: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + sourceFiles + +
      +
      +
      +
      +
      +
      +

      List of files to create a signing document from.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let sourceFiles: [File]
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + parentFolder + +
      +
      +
      +
      +
      +
      +

      The destination folder to place final, signed document and signing log.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let parentFolder: Folder
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + prefillTags + +
      +
      +
      +
      +
      +
      +

      List of prefill tags.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let prefillTags: [SignRequestPrefillTag]?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + daysValid + +
      +
      +
      +
      +
      +
      +

      Number of days after which this request will automatically expire if not completed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let daysValid: Int?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + externalId + +
      +
      +
      +
      +
      +
      +

      A reference ID in an external system that the sign request is related to.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let externalId: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestPrefillTag.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestPrefillTag.html new file mode 100644 index 000000000..617c9ee58 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestPrefillTag.html @@ -0,0 +1,1129 @@ + + + + SignRequestPrefillTag Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestPrefillTag

    +
    +
    + +
    public class SignRequestPrefillTag : BoxInnerModel
    + +
    +
    +

    Prefill tags are used to prefill placeholders with signer input data. +Only one value field can be included.

    + +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + documentTagId + +
      +
      +
      +
      +
      +
      +

      This references the ID of a specific tag contained in a file of the sign request

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let documentTagId: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + textValue + +
      +
      +
      +
      +
      +
      +

      Text prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let textValue: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + checkboxValue + +
      +
      +
      +
      +
      +
      +

      Checkbox prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let checkboxValue: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + dateValue + +
      +
      +
      +
      +
      +
      +

      Date prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let dateValue: Date?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    documentTagId: String?,
      +    textValue: String?
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + documentTagId + + +
      +

      Id of the tag.

      +
      +
      + + textValue + + +
      +

      The text prefill value.

      +
      +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    documentTagId: String?,
      +    checkboxValue: Bool?
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + documentTagId + + +
      +

      Id of the tag.

      +
      +
      + + checkboxValue + + +
      +

      The checkbox prefill value.

      +
      +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    documentTagId: String?,
      +    dateValue: Date?
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + documentTagId + + +
      +

      Id of the tag.

      +
      +
      + + dateValue + + +
      +

      The date prefill value.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignFiles.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignFiles.html new file mode 100644 index 000000000..a95d65067 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignFiles.html @@ -0,0 +1,986 @@ + + + + SignRequestSignFiles Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignFiles

    +
    +
    + +
    public class SignRequestSignFiles : BoxModel
    + +
    +
    +

    List of files that will be signed, which are copies of the original source files. +A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

    + +
    +
    +
    +
    + + +
    + +

    BoxModel +

    +
    +
    +
      +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + files + +
      +
      +
      +
      +
      +
      +

      Files that signing events will occur on - these are copies of the original source files.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let files: [File]?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + isReadyForDownload + +
      +
      +
      +
      +
      +
      +

      Indicates whether the signFiles documents are processing and the PDFs may be out of date. +A change to any document requires processing on all signFiles. +We recommended waiting until processing is finished (and this value is true) before downloading the PDFs.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isReadyForDownload: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSigner.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSigner.html new file mode 100644 index 000000000..8da152899 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSigner.html @@ -0,0 +1,1172 @@ + + + + SignRequestSigner Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSigner

    +
    +
    + +
    public class SignRequestSigner : BoxModel
    + +
    +
    +

    Represents a signer fields for GET Sign Request response.

    + +
    +
    +
    +
    + + +
    + +

    BoxModel +

    +
    +
    +
      +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + email + +
      +
      +
      +
      +
      +
      +

      Email address of the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let email: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + role + +
      +
      +
      +
      +
      +
      +

      Role of the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let role: SignRequestSignerRole?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + isInPerson + +
      +
      +
      +
      +
      +
      +

      Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isInPerson: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + order + +
      +
      +
      +
      +
      +
      +

      Order of the signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let order: Int?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      User ID for the signer in an external application responsible for authentication when accessing the embed URL.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let embedUrlExternalUserId: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + hasViewedDocument + +
      +
      +
      +
      +
      +
      +

      Flag which indicating if signer has viewed the document.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let hasViewedDocument: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + signerDecision + +
      +
      +
      +
      +
      +
      +

      Final decision made by the signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let signerDecision: SignRequestSignerDecision?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + inputs + +
      +
      +
      +
      +
      +
      +

      Inputs created by a signer on a sign request.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let inputs: [SignRequestSignerInput]?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + embedUrl + +
      +
      +
      +
      +
      +
      +

      URL to direct a signer to for signing.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let embedUrl: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignerDecision.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignerDecision.html new file mode 100644 index 000000000..3b9fed9ea --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignerDecision.html @@ -0,0 +1,983 @@ + + + + SignRequestSignerDecision Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerDecision

    +
    +
    + +
    public class SignRequestSignerDecision : BoxModel
    + +
    +
    +

    Final decision made by the signer

    + +
    +
    +
    +
    + + +
    + +

    BoxModel +

    +
    +
    +
      +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Type of decision made by the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let type: SignRequestSignerDecisionType?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + finalizedAt + +
      +
      +
      +
      +
      +
      +

      Date and Time that the decision was made

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let finalizedAt: Date?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignerInput.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignerInput.html new file mode 100644 index 000000000..c918e4ab0 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestSignerInput.html @@ -0,0 +1,1078 @@ + + + + SignRequestSignerInput Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerInput

    +
    +
    + +
    public class SignRequestSignerInput : BoxModel
    + +
    +
    +

    Prefill tags are used to prefill placeholders with signer input data. Only none value field can be included.

    + +
    +
    +
    +
    + + +
    + +

    Properties +

    +
    +
    +
      +
    • +
      + + + + rawData + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public private(set) var rawData: [String : Any] { get }
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Type of input

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let type: SignRequestSignerInputType?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + pageIndex + +
      +
      +
      +
      +
      +
      +

      Index of page that the input is on

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let pageIndex: Int
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + documentTagId + +
      +
      +
      +
      +
      +
      +

      This references the ID of a specific tag contained in a file of the sign request

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let documentTagId: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + textValue + +
      +
      +
      +
      +
      +
      +

      Text prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let textValue: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + checkboxValue + +
      +
      +
      +
      +
      +
      +

      Checkbox prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let checkboxValue: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + dateValue + +
      +
      +
      +
      +
      +
      +

      Date prefill value

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let dateValue: Date?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(json:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      +
      +

      Throws

      + Decoding error. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public required init(json: [String : Any]) throws
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + json + + +
      +

      JSON dictionary.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestsModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestsModule.html new file mode 100644 index 000000000..546c8aa0c --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SignRequestsModule.html @@ -0,0 +1,1182 @@ + + + + SignRequestsModule Class Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestsModule

    +
    +
    + +
    public class SignRequestsModule
    + +
    +
    +

    Provides management of Sign Requests

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Creates a sign request. This involves preparing a document for signing and sending the sign request to signers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func create(
      +    signers: [SignRequestCreateSigner],
      +    sourceFiles: [SignRequestCreateSourceFile],
      +    parentFolder: SignRequestCreateParentFolder,
      +    parameters: SignRequestCreateParameters? = nil,
      +    completion: @escaping Callback<SignRequest>
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + +
      + + signers + + +
      +

      List of signers for the sign request. 35 is the max number of signers permitted.

      +
      +
      + + sourceFiles + + +
      +

      List of files to create a signing document from.

      +
      +
      + + parentFolder + + +
      +

      The destination folder to place final, signed document and signing log. +The root folder, folder ID 0, cannot be used.

      +
      +
      + + parameters + + +
      +

      The optional parameters.

      +
      +
      + + completion + + +
      +

      Returns a SignRequest response object if successful otherwise a BoxSDKError.

      +
      +
      +
      +
      +
      +
    • +
    • +
      + + + + list(marker:limit:) + +
      +
      +
      +
      +
      +
      +

      List all sign requests.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func list(
      +    marker: String? = nil,
      +    limit: Int? = nil
      +) -> PagingIterator<SignRequest>
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + marker + + +
      +

      The position marker at which to begin the response. See marker-based paging for details.

      +
      +
      + + limit + + +
      +

      The maximum number of items to return.

      +
      +
      +
      +
      +

      Return Value

      +

      Returns a pagination iterator to fetch SignRequest items.

      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Get sign request by ID.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func getById(
      +    id: String,
      +    completion: @escaping Callback<SignRequest>
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + id + + +
      +

      The ID of the sign request.

      +
      +
      + + completion + + +
      +

      Returns a SignRequest response object if successful otherwise a BoxSDKError.

      +
      +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Resends a sign request email to all outstanding signers. +There is a 10 minute cooling-off period between each resend request. +If you make a resend call during the cooling-off period, a BoxAPIError will be thrown.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func resendById(
      +    id: String,
      +    completion: @escaping Callback<Void>
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + id + + +
      +

      The ID of the sign request.

      +
      +
      + + completion + + +
      +

      Returns an empty response if successful otherwise a BoxSDKError.

      +
      +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Cancels a sign request if it has not yet been signed or declined. +Any outstanding signers will no longer be able to sign the document.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public func cancelById(
      +    id: String,
      +    completion: @escaping Callback<SignRequest>
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + id + + +
      +

      The ID of the sign request.

      +
      +
      + + completion + + +
      +

      Returns a cancelled SignRequest response object if successful otherwise a BoxSDKError.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SingleTokenSession.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SingleTokenSession.html index 76ea75727..8eb249e09 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SingleTokenSession.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/SingleTokenSession.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -912,11 +960,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePoliciesModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePoliciesModule.html index a3d881a16..f0910547e 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePoliciesModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePoliciesModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1434,11 +1482,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicy.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicy.html index cdd4bae15..b7f1348c2 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicy.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    StoragePolicy

    -

    Properties

    +

    Properties

    @@ -940,11 +988,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicyAssignment.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicyAssignment.html index 49cc77a77..d190ce40b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicyAssignment.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicyAssignment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -999,11 +1047,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicyAssignment/AssignedTo.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicyAssignment/AssignedTo.html index d64be221a..4a362a42f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicyAssignment/AssignedTo.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/StoragePolicyAssignment/AssignedTo.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Task.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Task.html index bb583a4b1..7ef58a1b9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Task.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Task.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    Task

    -

    BoxModel

    +

    BoxModel

    @@ -839,7 +887,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1170,11 +1218,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TaskAssignment.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TaskAssignment.html index ff654889c..abcf173ce 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TaskAssignment.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TaskAssignment.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    TaskAssignment

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1115,11 +1163,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TasksModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TasksModule.html index f488e3396..3f69c9378 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TasksModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TasksModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    TasksModule

    -

    Tasks

    +

    Tasks

    @@ -1177,7 +1225,7 @@

    Parameters

    -

    Task Assignments

    +

    Task Assignments

    @@ -1653,11 +1701,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfService.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfService.html index 4cb861483..3fb736b23 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfService.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfService.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    TermsOfService

    -

    BoxModel

    +

    BoxModel

    @@ -839,7 +887,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1089,11 +1137,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfServiceUserStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfServiceUserStatus.html index e55d4f5d1..d52f5dd07 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfServiceUserStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfServiceUserStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    TermsOfServiceUserStatus

    -

    BoxModel

    +

    BoxModel

    @@ -838,7 +886,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1061,11 +1109,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfServicesModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfServicesModule.html index 341a70e53..8d745d5a5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfServicesModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TermsOfServicesModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1402,11 +1450,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Token.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Token.html index 4cb1848ce..d1535bea8 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Token.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Token.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    Token

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +859,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -980,11 +1028,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TokenInfo.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TokenInfo.html index fe4a51592..3d619abf7 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TokenInfo.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TokenInfo.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    TokenInfo

    -

    Properties

    +

    Properties

    @@ -1011,11 +1059,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TrackingCode.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TrackingCode.html index abd7bbc96..5e4898982 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TrackingCode.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TrackingCode.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -758,7 +806,8 @@

    TrackingCode

    -
    public class TrackingCode : BoxModel
    +
    @available(*, deprecated, message: "This class is obsoleted and will be removed. Please use User.TrackingCode instead.")
    +public class TrackingCode : BoxModel
    @@ -772,7 +821,7 @@

    TrackingCode

    -

    BoxModel

    +

    BoxModel

    @@ -811,7 +860,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -926,11 +975,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TrashModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TrashModule.html index 21841270b..438ce77b5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TrashModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/TrashModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1583,11 +1631,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadPart.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadPart.html index 65db3cfbd..f296b11d5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadPart.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadPart.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,7 +850,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -890,11 +938,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadSession.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadSession.html index 085a801cf..200bcfb7f 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadSession.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadSession.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -857,7 +905,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1081,11 +1129,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadSession/UploadSessionEndpoints.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadSession/UploadSessionEndpoints.html index 9dd62a923..085924c76 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadSession/UploadSessionEndpoints.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UploadSession/UploadSessionEndpoints.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -935,11 +983,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/User.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/User.html index e5590033f..9af3f07f7 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/User.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/User.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1660,11 +1708,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/User/TrackingCode.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/User/TrackingCode.html index bb63d9048..931f51fc8 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/User/TrackingCode.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/User/TrackingCode.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -827,11 +875,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UsersModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UsersModule.html index b705dbc86..2e49340e1 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UsersModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/UsersModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -2522,11 +2570,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Watermark.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Watermark.html index 0ca99c7ba..01513632a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Watermark.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Watermark.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -884,7 +932,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -999,11 +1047,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLink.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLink.html index b4119b3b6..1227f18cb 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLink.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLink.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1417,11 +1465,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLink/Permissions.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLink/Permissions.html index 88983d83b..f13c84602 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLink/Permissions.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLink/Permissions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLinksModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLinksModule.html index 4718c2a11..2a25f5ad5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLinksModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebLinksModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1411,11 +1459,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Webhook.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Webhook.html index c040acdbd..ba8dd275b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Webhook.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Webhook.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -804,7 +852,7 @@

    Declaration

    -

    BoxModel

    +

    BoxModel

    @@ -870,7 +918,7 @@

    Declaration

    -

    Properties

    +

    Properties

    @@ -1093,11 +1141,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Webhook/EventTriggers.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Webhook/EventTriggers.html index 1a3303338..40756cee3 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Webhook/EventTriggers.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/Webhook/EventTriggers.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1824,11 +1872,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebhooksModule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebhooksModule.html index 6ed549d9e..8475da60b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebhooksModule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/WebhooksModule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1203,11 +1251,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownload.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownload.html index dfce7d00b..f8f57e629 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownload.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownload.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownload

    -

    Properties

    +

    Properties

    @@ -967,11 +1015,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadConflict.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadConflict.html index 6b8ecb215..37eaba33d 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadConflict.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadConflict.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownloadConflict

    -

    Properties

    +

    Properties

    @@ -886,11 +934,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadConflictItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadConflictItem.html index 9e0cd5de0..20267e585 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadConflictItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadConflictItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownloadConflictItem

    -

    Properties

    +

    Properties

    @@ -967,11 +1015,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadStatus.html index a771cd663..6bfb196db 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Classes/ZipDownloadStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownloadStatus

    -

    Properties

    +

    Properties

    @@ -1021,11 +1069,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums.html index f4dc26a69..4de162528 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -2031,6 +2079,118 @@

    Declaration

    +
  • +
    + + + + SignRequestStatus + +
    +
    +
    +
    +
    +
    +

    Describes the status of the sign request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum SignRequestStatus : BoxEnum
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SignRequestSignerRole + +
    +
    +
    +
    +
    +
    +

    Defines the role of the signer in the sign request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum SignRequestSignerRole : BoxEnum
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Type of decision made by the signer

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum SignRequestSignerDecisionType : BoxEnum
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Represents a type of input.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum SignRequestSignerInputType : BoxEnum
    + +
    +
    +
    +
    +
  • @@ -2206,11 +2366,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AccessibleBy.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AccessibleBy.html index 4259cb091..464d1393c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AccessibleBy.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AccessibleBy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AssignmentState.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AssignmentState.html index 07917b011..683efeefc 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AssignmentState.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AssignmentState.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -960,11 +1008,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AssignmentStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AssignmentStatus.html index 2af527507..beec518bb 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AssignmentStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/AssignmentStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -960,11 +1008,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/BoxSDKErrorEnum.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/BoxSDKErrorEnum.html index 3fdae4ed4..1cfcfe81a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/BoxSDKErrorEnum.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/BoxSDKErrorEnum.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1500,11 +1548,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationDirection.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationDirection.html index 65489637a..ee0fe0492 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationDirection.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationDirection.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -933,11 +981,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationItem.html index 3d411bbb3..bc7ff920a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    CollaborationItem

    -

    BoxModel

    +

    BoxModel

    @@ -941,11 +989,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationRole.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationRole.html index e5f5b1242..8b87f0d24 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationRole.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationRole.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1089,11 +1137,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationStatus.html index 77f93c0d6..99c46bbf2 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CollaborationStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CommentItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CommentItem.html index 94ca89eca..b5e86a9c9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CommentItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/CommentItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    CommentItem

    -

    BoxModel

    +

    BoxModel

    @@ -941,11 +989,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ConflictResolution.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ConflictResolution.html index 4f7ae725c..cf6eea42e 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ConflictResolution.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ConflictResolution.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/DispositionAction.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/DispositionAction.html index 7c064f2dc..41b764bb6 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/DispositionAction.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/DispositionAction.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/EventObserverResponse.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/EventObserverResponse.html index 9248637b9..b559ba644 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/EventObserverResponse.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/EventObserverResponse.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/EventType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/EventType.html index 03619cdd6..6ba528a40 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/EventType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/EventType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    EventType

    -

    User events

    +

    User events

    @@ -1509,9 +1557,9 @@

    Declaration

  • @@ -1526,7 +1574,7 @@

    Declaration

    Declaration

    Swift

    -
    case masterInviteAccepted
    +
    case adminInviteAccepted
    @@ -1536,9 +1584,9 @@

    Declaration

  • @@ -1553,7 +1601,7 @@

    Declaration

    Declaration

    Swift

    -
    case masterInviteRejected
    +
    case adminInviteRejected
    @@ -1676,7 +1724,7 @@

    Declaration

    -

    Enterprise-only events

    +

    Enterprise-only events

    @@ -2869,6 +2917,33 @@

    Declaration

  • +
  • +
    + + + + contentAccessed + +
    +
    +
    +
    +
    +
    +

    A content was accessed by a user.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case contentAccessed
    + +
    +
    +
    +
    +
  • @@ -3763,9 +3838,9 @@

    Declaration

  • @@ -3773,14 +3848,14 @@

    Declaration

    -

    Folders were added to a group in the Admin console.

    +

    A watermarked file was downloaded.

    Declaration

    Swift

    -
    case itemsAddedToGroup
    +
    case watermarkedFileDownloaded
    @@ -3790,9 +3865,9 @@

    Declaration

  • @@ -3800,14 +3875,176 @@

    Declaration

    -

    A watermarked file was downloaded.

    +

    When a JWT application has been authorized or reauthorized

    Declaration

    Swift

    -
    case watermarkedFileDownloaded
    +
    case enterpriseAppAuthorizationUpdated
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A Shield justification is approved

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldJustificationApproved
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shieldAlert + +
    +
    +
    +
    +
    +
    +

    Shield detected an anomalous download, session, location, or malicious content based on enterprise Shield rules

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldAlert
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shieldAccessBlocked + +
    +
    +
    +
    +
    +
    +

    Access to an external collaboration is blocked

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldAccessBlocked
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Access to an external collaboration is blocked due to missing a justification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldBlockedMissingJustification
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shieldInviteBlocked + +
    +
    +
    +
    +
    +
    +

    An invite to externally collaborate is blocked

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldInviteBlocked
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    An invite to externally collaborate is blocked due to missing a justification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case shieldInviteBlockedMissingJustification
    @@ -3822,7 +4059,7 @@

    Declaration

    -

    Custom value

    +

    Custom value

    @@ -3932,11 +4169,10 @@

    Declaration

  • - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FileMetadataOperation.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FileMetadataOperation.html index 56ef0af44..261d78fd1 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FileMetadataOperation.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FileMetadataOperation.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -966,11 +1014,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FileRepresentationHint.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FileRepresentationHint.html index 5850e9678..d58ac7994 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FileRepresentationHint.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FileRepresentationHint.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -987,11 +1035,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderItem.html index 5316ab74f..be28cf976 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    FolderItem

    -

    BoxModel

    +

    BoxModel

    @@ -968,11 +1016,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderItemsOrderBy.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderItemsOrderBy.html index aa2f461cc..1a01e2451 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderItemsOrderBy.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderItemsOrderBy.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -988,11 +1036,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderMetadataOperation.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderMetadataOperation.html index 1e132b0fe..11b40291c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderMetadataOperation.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderMetadataOperation.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -912,11 +960,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderUploadEmailAccess.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderUploadEmailAccess.html index 08f8baa10..982dccff3 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderUploadEmailAccess.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/FolderUploadEmailAccess.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupInvitabilityLevel.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupInvitabilityLevel.html index 47f2b52e2..be6251c33 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupInvitabilityLevel.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupInvitabilityLevel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupMemberViewabilityLevel.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupMemberViewabilityLevel.html index 1aaa858c9..ebf3df0c1 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupMemberViewabilityLevel.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupMemberViewabilityLevel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupRole.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupRole.html index a5e4d68c3..29c24d071 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupRole.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/GroupRole.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ItemStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ItemStatus.html index 9b95a74a0..8a5fafb9b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ItemStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ItemStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -933,11 +981,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/LogCategory.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/LogCategory.html index af81f431f..3f273d670 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/LogCategory.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/LogCategory.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -909,11 +957,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/LogLevel.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/LogLevel.html index 29c671191..51184cd59 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/LogLevel.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/LogLevel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -909,11 +957,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataFilterBound.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataFilterBound.html index 3c6621ab4..9c3f5a7f6 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataFilterBound.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataFilterBound.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataScope.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataScope.html index dcad0496a..248918cf5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataScope.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataScope.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -932,11 +980,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataTemplateOperation.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataTemplateOperation.html index 80d3b1e08..e78d924cd 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataTemplateOperation.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/MetadataTemplateOperation.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1290,11 +1338,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/NullableParameter.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/NullableParameter.html index 2fcd57e12..5973fb3f4 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/NullableParameter.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/NullableParameter.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -832,7 +880,7 @@

    Declaration

    -

    Available where T: Encodable

    +

    Available where T: Encodable

    @@ -869,11 +917,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/OrderDirection.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/OrderDirection.html index f7ce7e5ef..bc6b557fc 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/OrderDirection.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/OrderDirection.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/PagingParameter.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/PagingParameter.html index c72cce108..9228ab04e 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/PagingParameter.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/PagingParameter.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyAssignmentItemType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyAssignmentItemType.html index 96cf3bc46..98a701699 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyAssignmentItemType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyAssignmentItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -933,11 +981,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyStatus.html index 3599a35df..8726ff353 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -907,11 +955,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyType.html index c9758a270..40957f723 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/RetentionPolicyType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -906,11 +954,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchContentType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchContentType.html index 0bebdbb2d..85eda1b5b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchContentType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchContentType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1008,11 +1056,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchItemType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchItemType.html index b41092924..84367fd27 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchItemType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchItemType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchScope.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchScope.html index aaf59cdc9..98962e5a6 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchScope.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SearchScope.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -928,11 +976,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SharedLinkAccess.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SharedLinkAccess.html index f0db5fcfb..df05cd2d9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SharedLinkAccess.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SharedLinkAccess.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -933,11 +981,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerDecisionType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerDecisionType.html new file mode 100644 index 000000000..5b05b68d9 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerDecisionType.html @@ -0,0 +1,963 @@ + + + + SignRequestSignerDecisionType Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerDecisionType

    +
    +
    + +
    public enum SignRequestSignerDecisionType : BoxEnum
    + +
    +
    +

    Type of decision made by the signer

    + +
    +
    +
    +
      +
    • +
      + + + + signed + +
      +
      +
      +
      +
      +
      +

      Signed decision.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case signed
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + declined + +
      +
      +
      +
      +
      +
      +

      Declined decision.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case declined
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + customValue(_:) + +
      +
      +
      +
      +
      +
      +

      A custom value not implemented in this version of SDK.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case customValue(String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(_:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(_ value: String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var description: String { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerInputType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerInputType.html new file mode 100644 index 000000000..90d40b153 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerInputType.html @@ -0,0 +1,1017 @@ + + + + SignRequestSignerInputType Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerInputType

    +
    +
    + +
    public enum SignRequestSignerInputType : BoxEnum
    + +
    +
    +

    Represents a type of input.

    + +
    +
    +
    +
      +
    • +
      + + + + signature + +
      +
      +
      +
      +
      +
      +

      Signature input.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case signature
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + date + +
      +
      +
      +
      +
      +
      +

      Date input.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case date
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + text + +
      +
      +
      +
      +
      +
      +

      Text input.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case text
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + checkbox + +
      +
      +
      +
      +
      +
      +

      Checkbox input.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case checkbox
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + customValue(_:) + +
      +
      +
      +
      +
      +
      +

      Custom value for enum values not yet implemented in the SDK

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case customValue(String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(_:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(_ value: String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var description: String { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerRole.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerRole.html new file mode 100644 index 000000000..4b01fdecc --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestSignerRole.html @@ -0,0 +1,990 @@ + + + + SignRequestSignerRole Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestSignerRole

    +
    +
    + +
    public enum SignRequestSignerRole : BoxEnum
    + +
    +
    +

    Defines the role of the signer in the sign request.

    + +
    +
    +
    +
      +
    • +
      + + + + signer + +
      +
      +
      +
      +
      +
      +

      Role needed to sign the document.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case signer
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + approver + +
      +
      +
      +
      +
      +
      +

      Role needed to approve the document.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case approver
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + finalCopyReader + +
      +
      +
      +
      +
      +
      +

      Role which receives the final signded document and signing log.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case finalCopyReader
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + customValue(_:) + +
      +
      +
      +
      +
      +
      +

      Custom value for enum values not yet implemented in the SDK

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case customValue(String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(_:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(_ value: String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var description: String { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestStatus.html new file mode 100644 index 000000000..63b1811b4 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SignRequestStatus.html @@ -0,0 +1,1179 @@ + + + + SignRequestStatus Enumeration Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestStatus

    +
    +
    + +
    public enum SignRequestStatus : BoxEnum
    + +
    +
    +

    Describes the status of the sign request.

    + +
    +
    +
    +
      +
    • +
      + + + + converting + +
      +
      +
      +
      +
      +
      +

      Converting status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case converting
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + created + +
      +
      +
      +
      +
      +
      +

      Created status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case created
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + sent + +
      +
      +
      +
      +
      +
      +

      Sent status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case sent
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + viewed + +
      +
      +
      +
      +
      +
      +

      Viewed status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case viewed
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + signed + +
      +
      +
      +
      +
      +
      +

      Signed status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case signed
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + cancelled + +
      +
      +
      +
      +
      +
      +

      Cancelled status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case cancelled
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + declined + +
      +
      +
      +
      +
      +
      +

      Declined status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case declined
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + errorConverting + +
      +
      +
      +
      +
      +
      +

      Error converting status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case errorConverting
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + errorSending + +
      +
      +
      +
      +
      +
      +

      Error sending status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case errorSending
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + expired + +
      +
      +
      +
      +
      +
      +

      Expired status.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case expired
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + customValue(_:) + +
      +
      +
      +
      +
      +
      +

      Custom value for enum values not yet implemented in the SDK

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case customValue(String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(_:) + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(_ value: String)
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + description + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var description: String { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/StreamPosition.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/StreamPosition.html index a80885e9a..70c9d1c70 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/StreamPosition.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/StreamPosition.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/StreamType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/StreamType.html index fd2209bf1..9fc3c3317 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/StreamType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/StreamType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SyncState.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SyncState.html index d597403a1..9cd3d2cf4 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SyncState.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/SyncState.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskAction.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskAction.html index 402fb83d6..15640a22b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskAction.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskAction.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskCompletionRule.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskCompletionRule.html index 2f0619cb3..26942f84e 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskCompletionRule.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskCompletionRule.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskItem.html index 771f6e891..5f11e4768 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TaskItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    TaskItem

    -

    BoxModel

    +

    BoxModel

    @@ -913,11 +961,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TermsOfServiceStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TermsOfServiceStatus.html index c46813145..3c917ba4a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TermsOfServiceStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TermsOfServiceStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TermsOfServiceType.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TermsOfServiceType.html index 26e3867d5..e90031adb 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TermsOfServiceType.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TermsOfServiceType.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -927,11 +975,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ThumbnailExtension.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ThumbnailExtension.html index b67548c3c..a67c269f4 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ThumbnailExtension.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/ThumbnailExtension.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TokenScope.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TokenScope.html index f37948b0a..e1a1f35e5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TokenScope.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/TokenScope.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1252,11 +1300,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/UserRole.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/UserRole.html index b42ca91bf..17733c4b9 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/UserRole.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/UserRole.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -954,11 +1002,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/UserStatus.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/UserStatus.html index 94bd646bc..43e0fc765 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/UserStatus.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/UserStatus.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -981,11 +1029,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/WebhookItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/WebhookItem.html index 2a8785d8f..6b1f0cffc 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/WebhookItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Enums/WebhookItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -773,7 +821,7 @@

    WebhookItem

    -

    BoxModel

    +

    BoxModel

    @@ -940,11 +988,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions.html index d30f5a21b..a9242a0aa 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -955,11 +1003,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Array.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Array.html index 14014c80f..5c8c4e20a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Array.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Array.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -771,7 +819,7 @@

    Array

    -

    Available where Element: StringProtocol

    +

    Available where Element: StringProtocol

    @@ -808,11 +856,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Bool.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Bool.html index 15fc344b5..27ac429f5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Bool.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Bool.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Int.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Int.html index 0b6ab6502..af2d45c83 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Int.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Int.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/NSNumber.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/NSNumber.html index 614eca1be..6f4126417 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/NSNumber.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/NSNumber.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/NSString.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/NSString.html index 5f8c97d7b..cd42cdc66 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/NSString.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/NSString.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Optional.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Optional.html index 6bdba82af..cb700bae4 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Optional.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/Optional.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -771,7 +819,7 @@

    Optional

    -

    Available where Wrapped: QueryParameterConvertible

    +

    Available where Wrapped: QueryParameterConvertible

    @@ -808,11 +856,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/String.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/String.html index e6b125ea5..4cde02572 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/String.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Extensions/String.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -799,11 +847,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols.html index 04fe83d3c..0a121eb13 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1073,11 +1121,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxClientProtocol.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxClientProtocol.html index 1037a2c46..f5d7d1538 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxClientProtocol.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxClientProtocol.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1598,11 +1646,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxEnum.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxEnum.html index e4ed24f68..5ce5aa8a1 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxEnum.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxEnum.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -822,7 +870,7 @@

    Parameters

    -

    Equatable

    +

    Equatable

    @@ -965,7 +1013,7 @@

    Return Value

    -

    Encodable

    +

    Encodable

    @@ -1008,7 +1056,7 @@

    Declaration

    -

    QueryParameterConvertible

    +

    QueryParameterConvertible

    @@ -1051,7 +1099,7 @@

    Declaration

    -

    Decodable

    +

    Decodable

    @@ -1091,11 +1139,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxModel.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxModel.html index ee38da5c1..84c12b999 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxModel.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/BoxModel.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -989,11 +1037,10 @@

    Return Value

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/ExpiredTokenHandling.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/ExpiredTokenHandling.html index d3ab1a5ed..f081af7ee 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/ExpiredTokenHandling.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/ExpiredTokenHandling.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -819,11 +867,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/LogDestination.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/LogDestination.html index 003601866..ab9b4e6df 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/LogDestination.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/LogDestination.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -800,11 +848,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/NetworkAgentProtocol.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/NetworkAgentProtocol.html index 3382ca14d..6fa2dff88 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/NetworkAgentProtocol.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/NetworkAgentProtocol.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -834,11 +882,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/QueryParameterConvertible.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/QueryParameterConvertible.html index 8234dcc6c..a314e659b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/QueryParameterConvertible.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/QueryParameterConvertible.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -800,11 +848,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/SessionProtocol.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/SessionProtocol.html index c307cac3f..7c2e1c1c7 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/SessionProtocol.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/SessionProtocol.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -951,11 +999,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/TokenRefreshing.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/TokenRefreshing.html index def039f32..ec5b38320 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/TokenRefreshing.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/TokenRefreshing.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -889,11 +937,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/TokenStore.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/TokenStore.html index a8406c285..98327de02 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/TokenStore.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Protocols/TokenStore.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -923,11 +971,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs.html index b60ad6b2b..197c4da9e 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -931,6 +979,146 @@

    Declaration

    +
  • + +
    +
    +
    +
    +
    +

    Represents a file version of a file included in a sign request

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateSourceFileVersion : Encodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Represents a file to be included in a sign request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateSourceFile : Encodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Represents a destination folder to place final, signed document and signing log.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateParentFolder : Encodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Defines a signer for Create Sign Request",

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateSigner : Encodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Defines a request to creatre a sign request object.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SignRequestCreateParameters : Encodable
    + +
    +
    +
    +
    +
  • @@ -1187,11 +1375,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxRequestDescription.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxRequestDescription.html index 8dfc5c7c7..328578bdb 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxRequestDescription.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxRequestDescription.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@
  • + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -881,11 +929,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxResponseDescription.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxResponseDescription.html index f6d244e80..d3fc177e1 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxResponseDescription.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxResponseDescription.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -854,11 +902,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxSDKConfiguration.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxSDKConfiguration.html index 6748fec0c..f3a0ebd00 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxSDKConfiguration.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxSDKConfiguration.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1104,11 +1152,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxURLComponents.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxURLComponents.html index c0c9d960d..f6f490f72 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxURLComponents.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/BoxURLComponents.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -908,11 +956,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ClientAnalyticsInfo.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ClientAnalyticsInfo.html index 82032872f..3e67a37e2 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ClientAnalyticsInfo.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ClientAnalyticsInfo.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -831,11 +879,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ConfigurablePermissionData.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ConfigurablePermissionData.html index ba089fa88..67b02c81c 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ConfigurablePermissionData.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ConfigurablePermissionData.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -969,11 +1017,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation.html index 381f1397f..369f7ada2 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -1027,11 +1075,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Content.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Content.html index 72cbf6913..3d533f0bb 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Content.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Content.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -803,11 +851,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Info.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Info.html index 44cfb7776..aa0e6cdf8 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Info.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Info.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -802,11 +850,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Status.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Status.html index 41666609a..dfceb1401 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Status.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/Status.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -800,11 +848,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/StatusEnum.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/StatusEnum.html index 3c55e812e..48e8b2c6b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/StatusEnum.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/FileRepresentation/StatusEnum.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -987,11 +1035,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/LockData.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/LockData.html index 88063496a..872f0275a 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/LockData.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/LockData.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -831,11 +879,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MetadataField.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MetadataField.html index cd2151c24..d5138d3d2 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MetadataField.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MetadataField.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    MetadataField

    -

    Properties

    +

    Properties

    @@ -1097,11 +1145,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MetadataFieldFilter.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MetadataFieldFilter.html index 0c029eb17..5be77df62 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MetadataFieldFilter.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MetadataFieldFilter.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    MetadataFieldFilter

    -

    Properties

    +

    Properties

    @@ -897,11 +945,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MultipartForm.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MultipartForm.html index c803196a3..0d977f981 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MultipartForm.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/MultipartForm.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -952,11 +1000,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SharedLinkData.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SharedLinkData.html index f219377f3..752081349 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SharedLinkData.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SharedLinkData.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -972,11 +1020,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateParameters.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateParameters.html new file mode 100644 index 000000000..6ddce81e9 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateParameters.html @@ -0,0 +1,1192 @@ + + + + SignRequestCreateParameters Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateParameters

    +
    +
    + +
    public struct SignRequestCreateParameters : Encodable
    + +
    +
    +

    Defines a request to creatre a sign request object.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isDocumentPreparationNeeded: Bool?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Disables the usage of signatures generated by typing (text). Default is true.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let areTextSignaturesEnabled: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + emailSubject + +
      +
      +
      +
      +
      +
      +

      Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let emailSubject: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + emailMessage + +
      +
      +
      +
      +
      +
      +

      Message to include in sign request email. The field is cleaned through sanitization of specific characters. +However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. +The message may contain the following html tags including : +a, abbr, acronym, b, blockquote, code, em, i, ul, li, ol, and strong. +Be aware that when the text to html ratio is too high, the email may end up in spam filters. +Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let emailMessage: String?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + areRemindersEnabled + +
      +
      +
      +
      +
      +
      +

      Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let areRemindersEnabled: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + prefillTags + +
      +
      +
      +
      +
      +
      +

      List of prefill tags. +When a document contains sign related tags in the content, you can prefill them using this prefillTags +by referencing the id of the tag as the externalId field of the prefill tag.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let prefillTags: [SignRequestPrefillTag]?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + daysValid + +
      +
      +
      +
      +
      +
      +

      Number of days after which this request will automatically expire if not completed.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let daysValid: Int?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + externalId + +
      +
      +
      +
      +
      +
      +

      This can be used to reference an ID in an external system that the sign request is related to.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let externalId: String?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    isDocumentPreparationNeeded: Bool? = nil,
      +    areTextSignaturesEnabled: Bool? = nil,
      +    emailSubject: String? = nil,
      +    emailMessage: String? = nil,
      +    areRemindersEnabled: Bool? = nil,
      +    prefillTags: [SignRequestPrefillTag]? = nil,
      +    daysValid: Int? = nil,
      +    externalId: String? = nil
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + + isDocumentPreparationNeeded + + +
      +

      Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

      +
      +
      + + areTextSignaturesEnabled + + +
      +

      Disables the usage of signatures generated by typing (text).

      +
      +
      + + emailSubject + + +
      +

      Subject of sign request email.

      +
      +
      + + emailMessage + + +
      +

      Message to include in sign request email.

      +
      +
      + + areRemindersEnabled + + +
      +

      Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18.

      +
      +
      + + prefillTags + + +
      +

      List of prefill tags.

      +
      +
      + + daysValid + + +
      +

      Number of days after which this request will automatically expire if not completed.

      +
      +
      + + externalId + + +
      +

      ID that serve as reference in an external system that the sign request is related to.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateParentFolder.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateParentFolder.html new file mode 100644 index 000000000..9a077c2a7 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateParentFolder.html @@ -0,0 +1,949 @@ + + + + SignRequestCreateParentFolder Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateParentFolder

    +
    +
    + +
    public struct SignRequestCreateParentFolder : Encodable
    + +
    +
    +

    Represents a destination folder to place final, signed document and signing log.

    + +
    +
    +
    +
      +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      Identifier of the folder

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let id: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(id:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(id: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + id + + +
      +

      Identifier of the folder that will be used as a destination place.

      +
      +
      +
      +
      +
      +
    • +
    • +
      + + + + init(folder:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(folder: Folder)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + folder + + +
      +

      The folder that will be used as a destination place.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSigner.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSigner.html new file mode 100644 index 000000000..295407371 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSigner.html @@ -0,0 +1,1066 @@ + + + + SignRequestCreateSigner Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateSigner

    +
    +
    + +
    public struct SignRequestCreateSigner : Encodable
    + +
    +
    +

    Defines a signer for Create Sign Request",

    + +
    +
    +
    +
      +
    • +
      + + + + email + +
      +
      +
      +
      +
      +
      +

      Email address of the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let email: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + role + +
      +
      +
      +
      +
      +
      +

      Role of the signer

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let role: SignRequestSignerRole?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + isInPerson + +
      +
      +
      +
      +
      +
      +

      Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let isInPerson: Bool?
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + order + +
      +
      +
      +
      +
      +
      +

      Order of the signer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let order: Int?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      User ID for the signer in an external application responsible for authentication when accessing the embed URL.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let embedUrlExternalUserId: String?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(
      +    email: String,
      +    role: SignRequestSignerRole? = nil,
      +    isInPerson: Bool? = nil,
      +    order: Int? = nil,
      +    embedUrlExternalUserId: String? = nil
      +)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + + + + + +
      + + email + + +
      +

      Email address of the signer.

      +
      +
      + + role + + +
      +

      Role of the signer.

      +
      +
      + + isInPerson + + +
      +

      flag that is used in combination with an embed url for a sender. +After the sender signs, they will be redirected to the next inPerson signer.

      +
      +
      + + order + + +
      +

      Order of the signer.

      +
      +
      + + embedUrlExternalUserId + + +
      +

      User ID for the signer in an external application responsible for authentication when accessing the embed URL.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSourceFile.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSourceFile.html new file mode 100644 index 000000000..03485da2c --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSourceFile.html @@ -0,0 +1,988 @@ + + + + SignRequestCreateSourceFile Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateSourceFile

    +
    +
    + +
    public struct SignRequestCreateSourceFile : Encodable
    + +
    +
    +

    Represents a file to be included in a sign request.

    + +
    +
    +
    +
      +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      Identifier of the file

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let id: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + fileVersion + +
      +
      +
      +
      +
      +
      +

      The version information of the file.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let fileVersion: SignRequestCreateSourceFileVersion?
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(id: String, fileVersionId: String? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + id + + +
      +

      Identifier of the file.

      +
      +
      + + fileVersionId + + +
      +

      Identifier of the file version.

      +
      +
      +
      +
      +
      +
    • +
    • +
      + + + + init(file:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(file: File)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + file + + +
      +

      The file that will be included in a sign request.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSourceFileVersion.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSourceFileVersion.html new file mode 100644 index 000000000..0734211f0 --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/SignRequestCreateSourceFileVersion.html @@ -0,0 +1,903 @@ + + + + SignRequestCreateSourceFileVersion Structure Reference + + + + + + + + + + + + + +
    +
    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    +
    + +
    +
    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    SignRequestCreateSourceFileVersion

    +
    +
    + +
    public struct SignRequestCreateSourceFileVersion : Encodable
    + +
    +
    +

    Represents a file version of a file included in a sign request

    + +
    +
    +
    +
      +
    • +
      + + + + id + +
      +
      +
      +
      +
      +
      +

      The ID of the file version object

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public let id: String
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + init(id:) + +
      +
      +
      +
      +
      +
      +

      Initializer.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public init(id: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + id + + +
      +

      Identifier of the file version.

      +
      +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/UploadPartDescription.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/UploadPartDescription.html index af11ee133..243139cb2 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/UploadPartDescription.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/UploadPartDescription.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -981,11 +1029,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ZipDownloadItem.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ZipDownloadItem.html index ff56393eb..323a36cbd 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ZipDownloadItem.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Structs/ZipDownloadItem.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -772,7 +820,7 @@

    ZipDownloadItem

    -

    Properties

    +

    Properties

    @@ -897,11 +945,10 @@

    Parameters

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Typealiases.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Typealiases.html index a5c22b6e6..271dab7a5 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Typealiases.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/Typealiases.html @@ -17,18 +17,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -341,6 +341,27 @@ + + + + + + + @@ -556,6 +577,18 @@ + + + + @@ -715,6 +748,21 @@ + + + + + @@ -958,11 +1006,10 @@

    Declaration

    - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/css/highlight.css b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/css/highlight.css index d0db0e13b..c170357ce 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/css/highlight.css +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/css/highlight.css @@ -1,200 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ /* Credit to https://gist.github.com/wataru420/2048287 */ -.highlight { - /* Comment */ - /* Error */ - /* Keyword */ - /* Operator */ - /* Comment.Multiline */ - /* Comment.Preproc */ - /* Comment.Single */ - /* Comment.Special */ - /* Generic.Deleted */ - /* Generic.Deleted.Specific */ - /* Generic.Emph */ - /* Generic.Error */ - /* Generic.Heading */ - /* Generic.Inserted */ - /* Generic.Inserted.Specific */ - /* Generic.Output */ - /* Generic.Prompt */ - /* Generic.Strong */ - /* Generic.Subheading */ - /* Generic.Traceback */ - /* Keyword.Constant */ - /* Keyword.Declaration */ - /* Keyword.Pseudo */ - /* Keyword.Reserved */ - /* Keyword.Type */ - /* Literal.Number */ - /* Literal.String */ - /* Name.Attribute */ - /* Name.Builtin */ - /* Name.Class */ - /* Name.Constant */ - /* Name.Entity */ - /* Name.Exception */ - /* Name.Function */ - /* Name.Namespace */ - /* Name.Tag */ - /* Name.Variable */ - /* Operator.Word */ - /* Text.Whitespace */ - /* Literal.Number.Float */ - /* Literal.Number.Hex */ - /* Literal.Number.Integer */ - /* Literal.Number.Oct */ - /* Literal.String.Backtick */ - /* Literal.String.Char */ - /* Literal.String.Doc */ - /* Literal.String.Double */ - /* Literal.String.Escape */ - /* Literal.String.Heredoc */ - /* Literal.String.Interpol */ - /* Literal.String.Other */ - /* Literal.String.Regex */ - /* Literal.String.Single */ - /* Literal.String.Symbol */ - /* Name.Builtin.Pseudo */ - /* Name.Variable.Class */ - /* Name.Variable.Global */ - /* Name.Variable.Instance */ - /* Literal.Number.Integer.Long */ } - .highlight .c { - color: #999988; - font-style: italic; } - .highlight .err { - color: #a61717; - background-color: #e3d2d2; } - .highlight .k { - color: #000000; - font-weight: bold; } - .highlight .o { - color: #000000; - font-weight: bold; } - .highlight .cm { - color: #999988; - font-style: italic; } - .highlight .cp { - color: #999999; - font-weight: bold; } - .highlight .c1 { - color: #999988; - font-style: italic; } - .highlight .cs { - color: #999999; - font-weight: bold; - font-style: italic; } - .highlight .gd { - color: #000000; - background-color: #ffdddd; } - .highlight .gd .x { - color: #000000; - background-color: #ffaaaa; } - .highlight .ge { - color: #000000; - font-style: italic; } - .highlight .gr { - color: #aa0000; } - .highlight .gh { - color: #999999; } - .highlight .gi { - color: #000000; - background-color: #ddffdd; } - .highlight .gi .x { - color: #000000; - background-color: #aaffaa; } - .highlight .go { - color: #888888; } - .highlight .gp { - color: #555555; } - .highlight .gs { - font-weight: bold; } - .highlight .gu { - color: #aaaaaa; } - .highlight .gt { - color: #aa0000; } - .highlight .kc { - color: #000000; - font-weight: bold; } - .highlight .kd { - color: #000000; - font-weight: bold; } - .highlight .kp { - color: #000000; - font-weight: bold; } - .highlight .kr { - color: #000000; - font-weight: bold; } - .highlight .kt { - color: #445588; } - .highlight .m { - color: #009999; } - .highlight .s { - color: #d14; } - .highlight .na { - color: #008080; } - .highlight .nb { - color: #0086B3; } - .highlight .nc { - color: #445588; - font-weight: bold; } - .highlight .no { - color: #008080; } - .highlight .ni { - color: #800080; } - .highlight .ne { - color: #990000; - font-weight: bold; } - .highlight .nf { - color: #990000; } - .highlight .nn { - color: #555555; } - .highlight .nt { - color: #000080; } - .highlight .nv { - color: #008080; } - .highlight .ow { - color: #000000; - font-weight: bold; } - .highlight .w { - color: #bbbbbb; } - .highlight .mf { - color: #009999; } - .highlight .mh { - color: #009999; } - .highlight .mi { - color: #009999; } - .highlight .mo { - color: #009999; } - .highlight .sb { - color: #d14; } - .highlight .sc { - color: #d14; } - .highlight .sd { - color: #d14; } - .highlight .s2 { - color: #d14; } - .highlight .se { - color: #d14; } - .highlight .sh { - color: #d14; } - .highlight .si { - color: #d14; } - .highlight .sx { - color: #d14; } - .highlight .sr { - color: #009926; } - .highlight .s1 { - color: #d14; } - .highlight .ss { - color: #990073; } - .highlight .bp { - color: #999999; } - .highlight .vc { - color: #008080; } - .highlight .vg { - color: #008080; } - .highlight .vi { - color: #008080; } - .highlight .il { - color: #009999; } +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/css/jazzy.css b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/css/jazzy.css index 5cdffe99c..2e3871391 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/css/jazzy.css +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/css/jazzy.css @@ -1,3 +1,7 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td { background: transparent; border: 0; @@ -79,6 +83,18 @@ blockquote { padding: 0 10px; border-left: 4px solid #ccc; } +hr { + height: 1px; + border: none; + background-color: #e2e2e2; } + +.footnote-ref { + display: inline-block; + scroll-margin-top: 70px; } + +.footnote-def { + scroll-margin-top: 70px; } + .content-wrapper { margin: 0 auto; width: 980px; } @@ -92,7 +108,7 @@ header { z-index: 3; } header img { padding-right: 6px; - vertical-align: -4px; + vertical-align: -3px; height: 16px; } header a { color: #fff; } diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/index.html b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/index.html index 3c9d37f45..b3368896e 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/index.html +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/index.html @@ -16,18 +16,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -340,6 +340,27 @@ + + + + + + + @@ -555,6 +576,18 @@ + + + + @@ -714,6 +747,21 @@ + + + + + @@ -760,6 +808,8 @@

    Box iOS SDK

    License Swift Package Manager Carthage compatible CocoaPods compatible Build Status Coverage Status

    + +

    Getting Started Docs: https://developer.box.com/guides/mobile/ios/quick-start/

    NOTE:

    The Box iOS SDK in Objective-C (prior to v3.0.0) has been moved from the main branch to the objective-c-maintenance branch. @@ -768,23 +818,37 @@

    NOTE:

    Box iOS SDK

  • Release Definitions
  • +
  • Release Candidate (RC)
  • +
  • Current Release
  • +
  • Long Term Support
  • +
  • Support Phases + +
  • Copyright and License
  • + @@ -798,22 +862,20 @@

    Installing the SDK

    Carthage

    Step 1: Add to your Cartfile

    -
    git "https://github.com/box/box-ios-sdk.git" ~> 4.0
    +
    git "https://github.com/box/box-ios-sdk.git" ~> 5.0
     

    Step 2: Update dependencies

    -
    $ carthage update --platform iOS
    +
    $ carthage update --use-xcframeworks --platform iOS
     
    -

    If you are using Xcode 12, you must follow the steps outlined here to install dependecies due to a bug in carthage.

    - -

    Step 3: Drag the built framework from Carthage/Build/iOS into your project.

    +

    Step 3: Drag the built xcframework from Carthage/Build into your project.

    For more detailed instructions, please see the official documentation for Carthage.

    CocoaPods

    Step 1: Add to your Podfile

    -
    pod 'BoxSDK', '~> 4.0'
    +
    pod 'BoxSDK', '~> 5.0'
     

    Step 2: Install pod by running the following command in the directory with the Podfile

    @@ -867,12 +929,12 @@

    OAuth2 Sample App

    To execute the sample app:

    Step 1: Run carthage

    -
    $ cd SampleApps/OAuth2SampleApp
    -$ carthage update --platform iOS
    +
    $ cd SampleApps/OAuth2SampleApp
    +$ carthage update --use-xcframeworks --platform iOS
     

    Step 2: Open Xcode Project File

    -
    $ open OAuth2SampleApp.xcodeproj
    +
    $ open OAuth2SampleApp.xcodeproj
     

    Step 3: Insert your client ID and client secret

    @@ -900,12 +962,12 @@

    JWT Auth Sample App

    To execute the sample app:

    Step 1: Run carthage

    -
    $ cd SampleApps/JWTSampleApp
    -$ carthage update --platform iOS
    +
    $ cd SampleApps/JWTSampleApp
    +$ carthage update --use-xcframeworks --platform iOS
     

    Step 2: Open Xcode Project File

    -
    $ open JWTSampleApp.xcodeproj
    +
    $ open JWTSampleApp.xcodeproj
     

    Step 3: Insert your client ID and client secret

    @@ -1030,11 +1092,10 @@ - diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jazzy.js b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jazzy.js index 1e55d6ef0..198441660 100755 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jazzy.js +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jazzy.js @@ -1,3 +1,7 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + window.jazzy = {'docset': false} if (typeof window.dash != 'undefined') { document.documentElement.className += ' dash' diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jazzy.search.js b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jazzy.search.js index e3d1ab905..359cdbb8b 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jazzy.search.js +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jazzy.search.js @@ -1,3 +1,7 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + $(function(){ var $typeahead = $('[data-typeahead]'); var $form = $typeahead.parents('form'); diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jquery.min.js b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jquery.min.js index b0614034a..c4c6022f2 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jquery.min.js +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/js/jquery.min.js @@ -1,2 +1,2 @@ -/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); +!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.9",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return void 0===e||null===e?"":e.toString()},e.utils.clone=function(e){if(null===e||void 0===e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i0){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/search.json b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/search.json index a73f5b1b4..df6cc4f18 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/search.json +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:6BoxSDK8Callbacka":{"name":"Callback","abstract":"

    Closure to return any generic type or an BoxSDKError"},"Typealiases.html#/s:6BoxSDK16TokenInfoClosurea":{"name":"TokenInfoClosure","abstract":"

    Closure returning either standard TokenInfo object or error."},"Typealiases.html#/s:6BoxSDK15QueryParametersa":{"name":"QueryParameters","abstract":"

    Represents API request query parameters.

    "},"Typealiases.html#/s:6BoxSDK0A11HTTPHeadersa":{"name":"BoxHTTPHeaders","abstract":"

    Represents HTTP headers for API requests.

    "},"Typealiases.html#/s:6BoxSDK16AccessTokenTuplea":{"name":"AccessTokenTuple","abstract":"

    Contains access token and its expiration date.

    "},"Typealiases.html#/s:6BoxSDK20DelegatedAuthClosurea":{"name":"DelegatedAuthClosure","abstract":"

    Contains unique ID as an identifier for JWT token provider and completion returning either valid access token information or an error.

    "},"Typealiases.html#/s:6BoxSDK18AccessTokenClosurea":{"name":"AccessTokenClosure","abstract":"

    Closure returning either access token string or error."},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV2idSSvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"ZipDownloadItem"},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV4typeSSvp":{"name":"type","abstract":"

    Box item type - should be file or folder.

    ","parent_name":"ZipDownloadItem"},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV2id4typeACSS_SStcfc":{"name":"init(id:type:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadItem"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV6partIdSSvp":{"name":"partId","abstract":"

    Part Id

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV6offsetSivp":{"name":"offset","abstract":"

    Part offset

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4sizeSivp":{"name":"size","abstract":"

    Part size

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4sha1SSSgvp":{"name":"sha1","abstract":"

    Part SHA hash

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    The upload part description’s raw data

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV18jsonRepresentationSDySSypGyF":{"name":"jsonRepresentation()","abstract":"

    Get the upload part description in JSON

    ","parent_name":"UploadPartDescription"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5fieldSSvp":{"name":"field","abstract":"

    The field to match against.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5valueSSvp":{"name":"value","abstract":"

    The value to match against.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5field5valueACSS_SStcfc":{"name":"init(field:value:)","abstract":"

    Initializer.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV2idSSSgvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV4typeSSSgvp":{"name":"type","abstract":"

    The data type of the field’s value.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV3keySSSgvp":{"name":"key","abstract":"

    A unique identifier for the field. The identifier must be unique within the template to which it belongs.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV11displayNameSSSgvp":{"name":"displayName","abstract":"

    The display name of the field.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the field.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV7optionsSaySDyS2SGGSgvp":{"name":"options","abstract":"

    For type enum, a list of all possible value

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV6hiddenSbSgvp":{"name":"hidden","abstract":"

    Whether this template is hidden in the UI

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV2id4type3key11displayName11description7options6hiddenACSSSg_A4KSaySDyS2SGGSgSbSgtcfc":{"name":"init(id:type:key:displayName:description:options:hidden:)","abstract":"

    Initializer.

    ","parent_name":"MetadataField"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO4noneyA2EmF":{"name":"none","abstract":"

    Generating the representation needs to be manually triggered (see info.url note).

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO7pendingyA2EmF":{"name":"pending","abstract":"

    Content is being generated but is not ready yet.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO8viewableyA2EmF":{"name":"viewable","abstract":"

    Similar to pending, though indicates that enough content is available to be useful.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO7successyA2EmF":{"name":"success","abstract":"

    All of the content is available and complete.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO5erroryA2EmF":{"name":"error","abstract":"

    An error happened and this content is not available.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    A custom value not implemented in this version of SDK.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"StatusEnum"},"Structs/FileRepresentation/Status.html#/s:6BoxSDK18FileRepresentationV6StatusV5stateAC0E4EnumOSgvp":{"name":"state","abstract":"

    State describing the status

    ","parent_name":"Status"},"Structs/FileRepresentation/Info.html#/s:6BoxSDK18FileRepresentationV4InfoV3urlSSSgvp":{"name":"url","abstract":"

    An opaque URL which will return status information about the file.

    ","parent_name":"Info"},"Structs/FileRepresentation/Content.html#/s:6BoxSDK18FileRepresentationV7ContentV11urlTemplateSSSgvp":{"name":"urlTemplate","abstract":"

    An opaque URL template to the content.

    ","parent_name":"Content"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV7contentAC7ContentVSgvp":{"name":"content","abstract":"

    An opaque URL template to the content.

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV4infoAC4InfoVSgvp":{"name":"info","abstract":"

    An opaque URL which will return status information about the file.

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV10propertiesSDyS2SGvp":{"name":"properties","abstract":"

    A set of static properties to distinguish between subtypes of a given representation,","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV6statusAC6StatusVSgvp":{"name":"status","abstract":"

    Status string

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV14representationSSSgvp":{"name":"representation","abstract":"

    Usually the extension of the format, but occasionally a name of a standard (potentially de facto)","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Content.html":{"name":"Content","abstract":"

    Contains an opaque URL template to the content, which follows RFC 6570.","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Info.html":{"name":"Info","abstract":"

    Contains an opaque URL which will return status information about the file.","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Status.html":{"name":"Status","abstract":"

    Defines the current status of the file representation generation

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation/StatusEnum.html":{"name":"StatusEnum","abstract":"

    A string with one of the following values: ‘none’, ‘pending’, ‘viewable’, ‘error’ and ‘success’.

    ","parent_name":"FileRepresentation"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV10statusCodeSiSgvp":{"name":"statusCode","abstract":"

    The HTTP status code of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV7headersSDyS2SGSgvp":{"name":"headers","abstract":"

    The HTTP headers of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV4bodySDySSypGSgvp":{"name":"body","abstract":"

    The body component of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV6methodSSvp":{"name":"method","abstract":"

    The HTTP method for the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV3urlAA0A13URLComponentsVvp":{"name":"url","abstract":"

    The URL the BoxRequest is sent to

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV7headersSDyS2SGvp":{"name":"headers","abstract":"

    The HTTP headers sent in the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV4bodySSSgvp":{"name":"body","abstract":"

    The optional body of the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV6schemeSSSgvp":{"name":"scheme","abstract":"

    URL scheme information

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV4hostSSSgvp":{"name":"host","abstract":"

    URL host information

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV4pathSSSgvp":{"name":"path","abstract":"

    URL path

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV5querySDyS2SGSgvp":{"name":"query","abstract":"

    Optional URL query parameters

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV8fragmentSSSgvp":{"name":"fragment","abstract":"

    Optional page reference / anchor

    ","parent_name":"BoxURLComponents"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV6accessAA0cD6AccessOSgvp":{"name":"access","abstract":"

    The access level for the shared link. Can be open (“People with the link”),","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV8passwordAA17NullableParameterOySSGSgvp":{"name":"password","abstract":"

    The password required to access the shared link.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV10unsharedAtAA17NullableParameterOy10Foundation4DateVGSgvp":{"name":"unsharedAt","abstract":"

    The date-time that this link will become disabled.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV11permissionsSDySSSbGSgvp":{"name":"permissions","abstract":"

    Whether the shared link allows downloads and previews.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV6access8password10unsharedAt11canDownloadAcA0cD6AccessOSg_AA17NullableParameterOySSGSgALy10Foundation4DateVGSgSbSgtcfc":{"name":"init(access:password:unsharedAt:canDownload:)","abstract":"

    Initializer.

    ","parent_name":"SharedLinkData"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormVACycfc":{"name":"init()","abstract":"

    Initialize an empty form.

    ","parent_name":"MultipartForm"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormV10appendPart4name8contentsySS_10Foundation4DataVtF":{"name":"appendPart(name:contents:)","abstract":"

    Append a body part to the form.

    ","parent_name":"MultipartForm"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormV14appendFilePart4name8contents6length8fileName8mimeTypeySS_So13NSInputStreamCSiS2StF":{"name":"appendFilePart(name:contents:length:fileName:mimeType:)","abstract":"

    Append a file body part to the form.

    ","parent_name":"MultipartForm"},"Structs/LockData.html#/s:6BoxSDK8LockDataV9expiresAt19isDownloadPreventedAC10Foundation4DateVSg_SbSgtcfc":{"name":"init(expiresAt:isDownloadPrevented:)","abstract":"

    Initializer.

    ","parent_name":"LockData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV13canRunReportsSbSgvp":{"name":"canRunReports","abstract":"

    Whether the user can run reports.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV15canInstantLoginSbSgvp":{"name":"canInstantLogin","abstract":"

    Whether the user can instant login.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV17canCreateAccountsSbSgvp":{"name":"canCreateAccounts","abstract":"

    Whether the user can create other accounts.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV15canEditAccountsSbSgvp":{"name":"canEditAccounts","abstract":"

    Whether the user can edit accounts.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV13canRunReports0F12InstantLogin0F14CreateAccounts0f4EditL0ACSbSg_A3Htcfc":{"name":"init(canRunReports:canInstantLogin:canCreateAccounts:canEditAccounts:)","abstract":"

    Initializer.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ClientAnalyticsInfo.html#/s:6BoxSDK19ClientAnalyticsInfoV7appName0F7VersionACSS_SStcfc":{"name":"init(appName:appVersion:)","abstract":"

    Initializer

    ","parent_name":"ClientAnalyticsInfo"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV8clientIdSSvp":{"name":"clientId","abstract":"

    The client ID of the application requesting authentication. To get the client ID for your application,","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV12clientSecretSSvp":{"name":"clientSecret","abstract":"

    The client secret of the application requesting authentication. To get the client secret for your application,","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV10apiBaseURL10Foundation0F0Vvp":{"name":"apiBaseURL","abstract":"

    Base URL for majority of the requests.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV16uploadApiBaseURL10Foundation0G0Vvp":{"name":"uploadApiBaseURL","abstract":"

    Base URL for file upload requests.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV18oauth2AuthorizeURL10Foundation0F0Vvp":{"name":"oauth2AuthorizeURL","abstract":"

    URL for the OAuth2 authorization page, where users are redirected to enter their credentials

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV16maxRetryAttemptsSivp":{"name":"maxRetryAttempts","abstract":"

    Maximum number of retries for a failed request.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV21tokenRefreshThresholdSdvp":{"name":"tokenRefreshThreshold","abstract":"

    Specifies how long before token expiration date it should be refreshed.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV17retryBaseIntervalSdvp":{"name":"retryBaseInterval","abstract":"

    The base factor used in calculating exponential backoff delay for retries

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV19clientAnalyticsInfoAA06ClienteF0VSgvp":{"name":"clientAnalyticsInfo","abstract":"

    Analytics info that is set to request headers.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV21consoleLogDestinationAA07ConsoleeF0Cvp":{"name":"consoleLogDestination","abstract":"

    Console log destination.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV18fileLogDestinationAA04FileeF0CSgvp":{"name":"fileLogDestination","abstract":"

    File log destination.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV11callbackURLSSvp":{"name":"callbackURL","abstract":"

    An optional custom callback URL string. The URL to which Box redirects the browser when authentication completes.","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html":{"name":"BoxSDKConfiguration","abstract":"

    SDK configuration specifying request related information

    "},"Structs/ClientAnalyticsInfo.html":{"name":"ClientAnalyticsInfo","abstract":"

    Analytics info about the app using the SDK.

    "},"Structs/ConfigurablePermissionData.html":{"name":"ConfigurablePermissionData","abstract":"

    Defines configurable permission data for creating and updating group membership."},"Structs/LockData.html":{"name":"LockData","abstract":"

    Defines a lock on a Box item

    "},"Structs/MultipartForm.html":{"name":"MultipartForm","abstract":"

    Representation of a multipart form request body.

    "},"Structs/SharedLinkData.html":{"name":"SharedLinkData","abstract":"

    Defines shared link data for updating file information."},"Structs/BoxURLComponents.html":{"name":"BoxURLComponents","abstract":"

    The components that make up a URL

    "},"Structs/BoxRequestDescription.html":{"name":"BoxRequestDescription","abstract":"

    The components that make up a description of a BoxRequest

    "},"Structs.html#/s:6BoxSDK0A8ResponseV":{"name":"BoxResponse","abstract":"

    Box API request response

    "},"Structs/BoxResponseDescription.html":{"name":"BoxResponseDescription","abstract":"

    The components that make up a description of a BoxResponse

    "},"Structs/FileRepresentation.html":{"name":"FileRepresentation","abstract":"

    Digital assets created for files stored in Box.

    "},"Structs/MetadataField.html":{"name":"MetadataField","abstract":"

    A field in a metadata template.

    "},"Structs/MetadataFieldFilter.html":{"name":"MetadataFieldFilter","abstract":"

    Filter for matching against a metadata field

    "},"Structs/UploadPartDescription.html":{"name":"UploadPartDescription","abstract":"

    Description of uploaded part

    "},"Structs/ZipDownloadItem.html":{"name":"ZipDownloadItem","abstract":"

    Item field for creating a Zip download.

    "},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP4read10completionyys6ResultOyAA0C4InfoCs5Error_pGc_tF":{"name":"read(completion:)","abstract":"

    Retrieves current token information

    ","parent_name":"TokenStore"},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP5write9tokenInfo10completionyAA0cG0C_ys6ResultOyyts5Error_pGctF":{"name":"write(tokenInfo:completion:)","abstract":"

    Sets new token data

    ","parent_name":"TokenStore"},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP5clear10completionyys6ResultOyyts5Error_pGc_tF":{"name":"clear(completion:)","abstract":"

    Removes a token

    ","parent_name":"TokenStore"},"Protocols/ExpiredTokenHandling.html#/s:6BoxSDK20ExpiredTokenHandlingP06handlecD010completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"handleExpiredToken(completion:)","abstract":"

    Handles token expiration.

    ","parent_name":"ExpiredTokenHandling"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","abstract":"

    Gets access token

    ","parent_name":"SessionProtocol"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","abstract":"

    Revokes all the tokens

    ","parent_name":"SessionProtocol"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP14downscopeToken5scope8resource10sharedLink10completionyShyAA0F5ScopeOG_SSSgALys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"SessionProtocol"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    Raw data from the API that populates the model

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonx10Foundation4DataV_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonSSyF":{"name":"json()","abstract":"

    Gets JSON string for a Box model object.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelPAAE12toJSONStringSSyF":{"name":"toJSONString()","abstract":"

    Gets JSON string for a Box model object.

    ","parent_name":"BoxModel"},"Protocols/QueryParameterConvertible.html#/s:6BoxSDK25QueryParameterConvertibleP15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"QueryParameterConvertible"},"Protocols/NetworkAgentProtocol.html#/s:6BoxSDK20NetworkAgentProtocolP4send7request10completionyAA0A7RequestC_ys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"send(request:completion:)","abstract":"

    Makes a Box SDK request

    ","parent_name":"NetworkAgentProtocol"},"Protocols/TokenRefreshing.html#/s:6BoxSDK15TokenRefreshingP7refresh0eC010completionySS_ys6ResultOyAA0C4InfoCAA0A8SDKErrorCGctF":{"name":"refresh(refreshToken:completion:)","abstract":"

    Refreshes a token.

    ","parent_name":"TokenRefreshing"},"Protocols/TokenRefreshing.html#/s:6BoxSDK15TokenRefreshingP03getC08withCode10completionySS_ys6ResultOyAA0C4InfoCAA0A8SDKErrorCGctF":{"name":"getToken(withCode:completion:)","abstract":"

    Exchange an authorization code for an access token

    ","parent_name":"TokenRefreshing"},"Protocols/LogDestination.html#/s:6BoxSDK14LogDestinationP5write_5level8category_ys12StaticStringV_AA0C5LevelOAA0C8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message

    ","parent_name":"LogDestination"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE2eeoiySbx_SStFZ":{"name":"==(_:_:)","abstract":"

    Compare equality between enum and string

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE2eeoiySbSS_xtFZ":{"name":"==(_:_:)","abstract":"

    Compare equality between string and enum

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

    Encode the enum to a JSON string

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

    Initialization using decoder

    ","parent_name":"BoxEnum"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3get3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"get(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP GET method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP4post3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP4post3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters4data8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAM4DataVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:data:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response - variant for chunked upload.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP7options3url11httpHeaders15queryParameters4json10completionAA0A11NetworkTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"options(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP OPTIONS method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP6delete3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"delete(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP DELETE method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html":{"name":"BoxClientProtocol","abstract":"

    Defines methods for communication with Box APIs

    "},"Protocols/BoxEnum.html":{"name":"BoxEnum","abstract":"

    General BoxEnum protocol specifying response model enum behaviour

    "},"Protocols/LogDestination.html":{"name":"LogDestination","abstract":"

    Defines main log destination behaviour

    "},"Protocols/TokenRefreshing.html":{"name":"TokenRefreshing","abstract":"

    Defines methods for Token refreshing.

    "},"Protocols/NetworkAgentProtocol.html":{"name":"NetworkAgentProtocol","abstract":"

    Defines networking layer interface

    "},"Protocols/QueryParameterConvertible.html":{"name":"QueryParameterConvertible","abstract":"

    Defines items convertible to query parameter

    "},"Protocols/BoxModel.html":{"name":"BoxModel","abstract":"

    Defines Box SDK model behavior

    "},"Protocols.html#/s:6BoxSDK0A10InnerModelP":{"name":"BoxInnerModel","abstract":"

    Box inner model

    "},"Protocols/SessionProtocol.html":{"name":"SessionProtocol","abstract":"

    Defines methods for managing session token.

    "},"Protocols/ExpiredTokenHandling.html":{"name":"ExpiredTokenHandling","abstract":"

    Defines handler for expired token.

    "},"Protocols/TokenStore.html":{"name":"TokenStore","abstract":"

    Defines an interface for managing token.

    "},"Extensions/Optional.html#/s:Sq6BoxSDKAA25QueryParameterConvertibleRzlE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Optional"},"Extensions/Array.html#/s:Sa6BoxSDKSyRzlE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Array"},"Extensions/NSString.html#/s:So8NSStringC6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"NSString"},"Extensions/NSNumber.html#/s:So8NSNumberC6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"NSNumber"},"Extensions/Bool.html#/s:Sb6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Bool"},"Extensions/Int.html#/s:Si6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Int"},"Extensions/String.html#/s:SS6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"String"},"Extensions/String.html":{"name":"String"},"Extensions/Int.html":{"name":"Int"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/NSNumber.html":{"name":"NSNumber"},"Extensions/NSString.html":{"name":"NSString"},"Extensions/Array.html":{"name":"Array"},"Extensions/Optional.html":{"name":"Optional"},"Enums/WebhookItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO6folderyAcA6FolderCcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"WebhookItem"},"Enums/TaskItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:6BoxSDK8TaskItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File with task assignment.

    ","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:6BoxSDK8TaskItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"TaskItem"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO9completedyA2CmF":{"name":"completed","abstract":"

    Completed

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO10incompleteyA2CmF":{"name":"incomplete","abstract":"

    Incomplete

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO8approvedyA2CmF":{"name":"approved","abstract":"

    Approved

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Rejected

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not implemented in this version of SDK.

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AssignmentState"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO9completedyA2CmF":{"name":"completed","abstract":"

    Completed

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO10incompleteyA2CmF":{"name":"incomplete","abstract":"

    Incomplete

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO8approvedyA2CmF":{"name":"approved","abstract":"

    Approved

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Rejected

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not implemented in this version of SDK.

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AssignmentStatus"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO6reviewyA2CmF":{"name":"review","abstract":"

    Approval task that can be approved or rejected

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO8completeyA2CmF":{"name":"complete","abstract":"

    General task which can be completed

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom task action

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"TaskAction"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO12allAssigneesyA2CmF":{"name":"allAssignees","abstract":"

    Task is complete when all assignees complete it

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11anyAssigneeyA2CmF":{"name":"anyAssignee","abstract":"

    Task is complete when any assignees complete it

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"TaskCompletionRule"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO4openyA2CmF":{"name":"open","abstract":"

    Anyone with the link can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO7companyyA2CmF":{"name":"company","abstract":"

    People in your company can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO13collaboratorsyA2CmF":{"name":"collaborators","abstract":"

    People in this folder can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented by the SDK

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SharedLinkAccess"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO14annotationEdityA2CmF":{"name":"annotationEdit","abstract":"

    Allow user to edit annotations (delete).

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO17annotationViewAllyA2CmF":{"name":"annotationViewAll","abstract":"

    Allows user to view all users’ annotations.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO18annotationViewSelfyA2CmF":{"name":"annotationViewSelf","abstract":"

    Allows user to view their own annotations only.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO12baseExploreryA2CmF":{"name":"baseExplorer","abstract":"

    Allows access to content in the folder tree based on user/file/token permissions.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10basePickeryA2CmF":{"name":"basePicker","abstract":"

    Allows access to content in the folder tree based on user/file/token permissions.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11basePreviewyA2CmF":{"name":"basePreview","abstract":"

    Allows the user to preview the file, nothing else.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11baseSidebaryA2CmF":{"name":"baseSidebar","abstract":"

    Allows the user to get basic file info needed for the sidebar.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10baseUploadyA2CmF":{"name":"baseUpload","abstract":"

    Allows upload into the folder specific under “resource” of the Token Exchange request.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemDeleteyA2CmF":{"name":"itemDelete","abstract":"

    Allows file/folders to be deleted.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO12itemDownloadyA2CmF":{"name":"itemDownload","abstract":"

    Allows files/folders contents to be downloaded.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11itemPreviewyA2CmF":{"name":"itemPreview","abstract":"

    Automatically enables preview of the file, upon user click (requires Preview UI Element to be referenced).

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemRenameyA2CmF":{"name":"itemRename","abstract":"

    Allows files/folders to be renamed.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO9itemShareyA2CmF":{"name":"itemShare","abstract":"

    Allows sharing of resource specified under “resource” of the Token Exchange request.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemUploadyA2CmF":{"name":"itemUpload","abstract":"

    Allows upload in the content picker.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom permission that was not yet implemented in this version of SDK.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of token scope

    ","parent_name":"TokenScope"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO6folderyA2CmF":{"name":"folder","abstract":"

    Folder type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    Enterprise type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO16metadataTemplateyA2CmF":{"name":"metadataTemplate","abstract":"

    Metadata template type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this version of SDK.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO6activeyA2CmF":{"name":"active","abstract":"

    Retention policy is active.

    ","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO7retiredyA2CmF":{"name":"retired","abstract":"

    Retention policy is retired. Can be only retired by administrator","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value that was not yet implemented in current SDK version.

    ","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyStatus"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO17permanentlyDeleteyA2CmF":{"name":"permanentlyDelete","abstract":"

    Content retained by the policy to be permanently deleted once the retention policy time period has passed.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO15removeRetentionyA2CmF":{"name":"removeRetention","abstract":"

    Will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy time period has passed.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in the SDK.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"DispositionAction"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO6finiteyA2CmF":{"name":"finite","abstract":"

    A specific amount of time to retain the content is known upfront.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO10indefiniteyA2CmF":{"name":"indefinite","abstract":"

    The amount of time to retain the content is still unknown.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this SDK version.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyType"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO13addEnumOptionyACSS_SDySSypGtcACmF":{"name":"addEnumOption(fieldKey:data:)","abstract":"

    Adds an enum option at the end of the enum option list for the specified field.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO8addFieldyACSDySSypG_tcACmF":{"name":"addField(data:)","abstract":"

    Adds a field at the end of the field list for the template.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO04editD0yACSDySSypG_tcACmF":{"name":"editTemplate(data:)","abstract":"

    Edits any number of the base properties of a template: displayName, hidden.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO18reorderEnumOptionsyACSS_SaySSGtcACmF":{"name":"reorderEnumOptions(fieldKey:enumOptionKeys:)","abstract":"

    Reorders the enum option list to match the requested enum option list.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO13reorderFieldsyACSaySSG_tcACmF":{"name":"reorderFields(fieldKeys:)","abstract":"

    Reorders the field list to match the requested field list

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO9editFieldyACSS_SDySSypGtcACmF":{"name":"editField(fieldKey:data:)","abstract":"

    Edits any number of the base properties of a field: displayName, hidden, description, key.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO14editEnumOptionyACSS_SDySSypGSStcACmF":{"name":"editEnumOption(fieldKey:data:enumOptionKey:)","abstract":"

    Edits the enumOption.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO16removeEnumOptionyACSS_SStcACmF":{"name":"removeEnumOption(fieldKey:enumOptionKey:)","abstract":"

    Removes the specified enum option from the specified enum field.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO11removeFieldyACSS_tcACmF":{"name":"removeField(fieldKey:)","abstract":"

    Removes the specified field from the template

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an option.

    ","parent_name":"MetadataTemplateOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO3addyACSS_SStcACmF":{"name":"add(path:value:)","abstract":"

    Adds new metadata path/value pair

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO7replaceyACSS_SStcACmF":{"name":"replace(path:value:)","abstract":"

    Replaces metadata for path with a new value

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO4testyACSS_SStcACmF":{"name":"test(path:value:)","abstract":"

    Tests expected metadata value for given path

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO6removeyACSS_tcACmF":{"name":"remove(path:)","abstract":"

    Removes metadata for given path

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an operation option.

    ","parent_name":"FolderMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO3addyACSS_SStcACmF":{"name":"add(path:value:)","abstract":"

    Adds new metadata path/value pair

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO7replaceyACSS_SStcACmF":{"name":"replace(path:value:)","abstract":"

    Replaces metadata for path with a new value

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4testyACSS_SStcACmF":{"name":"test(path:value:)","abstract":"

    Tests expected metadata value for given path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO6removeyACSS_tcACmF":{"name":"remove(path:)","abstract":"

    Removes metadata for given path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4moveyACSS_SStcACmF":{"name":"move(from:path:)","abstract":"

    Moves metadata from original path to new path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4copyyACSS_SStcACmF":{"name":"copy(from:path:)","abstract":"

    Copies metadata from original path to new path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an operation option.

    ","parent_name":"FileMetadataOperation"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO6memberyA2CmF":{"name":"member","abstract":"

    Default permission for a user in a Group.

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO5adminyA2CmF":{"name":"admin","abstract":"

    The admin of the Group.

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access that is not yet implemented

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"GroupRole"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO10adminsOnlyyA2CmF":{"name":"adminsOnly","abstract":"

    Main Admin, Coadmins and group’s Group Admin can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO16adminsAndMembersyA2CmF":{"name":"adminsAndMembers","abstract":"

    Admins and group members can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO15allManagedUsersyA2CmF":{"name":"allManagedUsers","abstract":"

    All managed users in the enterprise can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom level that was not yet implemented in this version of SDK.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO11descriptionSSvp":{"name":"description","abstract":"

    String representation of member viewability level

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO10adminsOnlyyA2CmF":{"name":"adminsOnly","abstract":"

    Main Admin, Co-admins, the group’s Group Admin can invite

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO16adminsAndMembersyA2CmF":{"name":"adminsAndMembers","abstract":"

    Admins and group members can invite

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO15allManagedUsersyA2CmF":{"name":"allManagedUsers","abstract":"

    All managed users in the enterprise.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom level that was not yet implemented in this version of SDK.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO11descriptionSSvp":{"name":"description","abstract":"

    String representation of invitability level.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/FolderItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO6folderyAcA0C0CcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO7webLinkyAcA03WebF0CcACmF":{"name":"webLink(_:)","abstract":"

    Weblink type pointing to either a file or folder.

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Item debug description.

    ","parent_name":"FolderItem"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO11descriptionSSvp":{"name":"description","abstract":"

    String representation of sync state.

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO6syncedyA2CmF":{"name":"synced","abstract":"

    Folder will be synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO9notSyncedyA2CmF":{"name":"notSynced","abstract":"

    Folder will not be synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO15partiallySyncedyA2CmF":{"name":"partiallySynced","abstract":"

    Folder is partially synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom sync option, that is not yet implemented in this SDK version.

    ","parent_name":"SyncState"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO3pdfyA2CmF":{"name":"pdf","abstract":"

    The PDF representation

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO9thumbnailyA2CmF":{"name":"thumbnail","abstract":"

    Thumbnail image with resolution 320x320px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO11imageMediumyA2CmF":{"name":"imageMedium","abstract":"

    Image with resolution 1024x1024px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO10imageLargeyA2CmF":{"name":"imageLarge","abstract":"

    Image with resolution 2048x2048px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO13extractedTextyA2CmF":{"name":"extractedText","abstract":"

    Extracted text from original document.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    It is possible to use a custom value. See representations documentation.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"FileRepresentationHint"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemCreatedyA2CmF":{"name":"itemCreated","abstract":"

    A folder or file was created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12itemUploadedyA2CmF":{"name":"itemUploaded","abstract":"

    A folder or file was uploaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14commentCreatedyA2CmF":{"name":"commentCreated","abstract":"

    A comment was created on a folder, file, or other comment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14commentDeletedyA2CmF":{"name":"commentDeleted","abstract":"

    A comment was deleted on folder, file, or other comment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14itemDownloadedyA2CmF":{"name":"itemDownloaded","abstract":"

    A file or folder was downloaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13itemPreviewedyA2CmF":{"name":"itemPreviewed","abstract":"

    A file was previewed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9itemMovedyA2CmF":{"name":"itemMoved","abstract":"

    A file or folder was moved.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemCopiedyA2CmF":{"name":"itemCopied","abstract":"

    A file or folder was copied.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12taskAssignedyA2CmF":{"name":"taskAssigned","abstract":"

    A task was assigned.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11taskCreatedyA2CmF":{"name":"taskCreated","abstract":"

    A task was created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10fileLockedyA2CmF":{"name":"fileLocked","abstract":"

    A file was locked.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12fileUnlockedyA2CmF":{"name":"fileUnlocked","abstract":"

    A file was unlocked. If a locked file is deleted, the source file will be null.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemDeletedyA2CmF":{"name":"itemDeleted","abstract":"

    A file or folder was marked as deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13itemRecoveredyA2CmF":{"name":"itemRecovered","abstract":"

    A file or folder was recovered out of the trash.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17collaboratorAddedyA2CmF":{"name":"collaboratorAdded","abstract":"

    A collaborator was added to a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23collaboratorRoleChangedyA2CmF":{"name":"collaboratorRoleChanged","abstract":"

    A collaborator had their role changed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19collaboratorInvitedyA2CmF":{"name":"collaboratorInvited","abstract":"

    A collaborator was invited on a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19collaboratorRemovedyA2CmF":{"name":"collaboratorRemoved","abstract":"

    A collaborator was removed from a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8itemSyncyA2CmF":{"name":"itemSync","abstract":"

    A folder was marked for sync.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemUnsyncyA2CmF":{"name":"itemUnsync","abstract":"

    A folder was un-marked for sync.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemRenamedyA2CmF":{"name":"itemRenamed","abstract":"

    A file or folder was renamed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21itemEnabledForSharingyA2CmF":{"name":"itemEnabledForSharing","abstract":"

    A file or folder was enabled for sharing.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22itemDisabledForSharingyA2CmF":{"name":"itemDisabledForSharing","abstract":"

    A file or folder was disabled for sharing.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemSharedyA2CmF":{"name":"itemShared","abstract":"

    A folder was shared.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22itemMadeCurrentVersionyA2CmF":{"name":"itemMadeCurrentVersion","abstract":"

    A previous version of a file was promoted to the current version.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8tagAddedyA2CmF":{"name":"tagAdded","abstract":"

    A Tag was added to a file or folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16twoFactorEnabledyA2CmF":{"name":"twoFactorEnabled","abstract":"

    2 factor authentication enabled by user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20masterInviteAcceptedyA2CmF":{"name":"masterInviteAccepted","abstract":"

    Free user accepts invitation to become a managed user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20masterInviteRejectedyA2CmF":{"name":"masterInviteRejected","abstract":"

    Free user rejects invitation to become a managed user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13accessGrantedyA2CmF":{"name":"accessGranted","abstract":"

    Granted Box access to account.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13accessRevokedyA2CmF":{"name":"accessRevoked","abstract":"

    Revoke Box access to account.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16addedUserToGroupyA2CmF":{"name":"addedUserToGroup","abstract":"

    Added user to group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20removedUserFromGroupyA2CmF":{"name":"removedUserFromGroup","abstract":"

    Removed user from group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11createdUseryA2CmF":{"name":"createdUser","abstract":"

    Created user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12createdGroupyA2CmF":{"name":"createdGroup","abstract":"

    Created new group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12deletedGroupyA2CmF":{"name":"deletedGroup","abstract":"

    Deleted group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11deletedUseryA2CmF":{"name":"deletedUser","abstract":"

    Deleted user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11editedGroupyA2CmF":{"name":"editedGroup","abstract":"

    Edited group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10editedUseryA2CmF":{"name":"editedUser","abstract":"

    Edited user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10adminLoginyA2CmF":{"name":"adminLogin","abstract":"

    Admin login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21addedDeviceAssocationyA2CmF":{"name":"addedDeviceAssocation","abstract":"

    Added device association

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22changeFolderPermissionyA2CmF":{"name":"changeFolderPermission","abstract":"

    Edit the permissions on a folder

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11failedLoginyA2CmF":{"name":"failedLogin","abstract":"

    Failed login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO5loginyA2CmF":{"name":"login","abstract":"

    Login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24removedDeviceAssociationyA2CmF":{"name":"removedDeviceAssociation","abstract":"

    Removed device association

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22deviceTrustCheckFailedyA2CmF":{"name":"deviceTrustCheckFailed","abstract":"

    Device Trust check failed

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22termsOfServiceAcceptedyA2CmF":{"name":"termsOfServiceAccepted","abstract":"

    Accepted terms

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22termsOfServiceRejectedyA2CmF":{"name":"termsOfServiceRejected","abstract":"

    Rejected terms

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19fileMarkedMaliciousyA2CmF":{"name":"fileMarkedMalicious","abstract":"

    Virus found on a file. Event is only received by enterprises that have opted in to be notified.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6copiedyA2CmF":{"name":"copied","abstract":"

    Copied

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO7deletedyA2CmF":{"name":"deleted","abstract":"

    Deleted

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10downloadedyA2CmF":{"name":"downloaded","abstract":"

    Downloaded

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6editedyA2CmF":{"name":"edited","abstract":"

    Edited

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6lockedyA2CmF":{"name":"locked","abstract":"

    Locked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO5movedyA2CmF":{"name":"moved","abstract":"

    Moved

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9previewedyA2CmF":{"name":"previewed","abstract":"

    Previewed

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO7renamedyA2CmF":{"name":"renamed","abstract":"

    A file or folder name or description is changed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17storageExpirationyA2CmF":{"name":"storageExpiration","abstract":"

    Set file auto-delete

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9undeletedyA2CmF":{"name":"undeleted","abstract":"

    Undeleted

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8unlockedyA2CmF":{"name":"unlocked","abstract":"

    Unlocked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8uploadedyA2CmF":{"name":"uploaded","abstract":"

    Uploaded

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12shareEnabledyA2CmF":{"name":"shareEnabled","abstract":"

    Enabled shared links

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16itemShareUpdatedyA2CmF":{"name":"itemShareUpdated","abstract":"

    Share links settings updated

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22shareExpirationUpdatedyA2CmF":{"name":"shareExpirationUpdated","abstract":"

    Extend shared link expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15shareExpirationyA2CmF":{"name":"shareExpiration","abstract":"

    Set shared link expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8unsharedyA2CmF":{"name":"unshared","abstract":"

    Unshared shared link

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21collaborationAcceptedyA2CmF":{"name":"collaborationAccepted","abstract":"

    Accepted invites

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24collaborationRoleChangedyA2CmF":{"name":"collaborationRoleChanged","abstract":"

    Changed user roles

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO31collaborationExpirationExtendedyA2CmF":{"name":"collaborationExpirationExtended","abstract":"

    Extend collaborator expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20collaborationRemovedyA2CmF":{"name":"collaborationRemoved","abstract":"

    Removed collaborators

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22invitedToCollaborationyA2CmF":{"name":"invitedToCollaboration","abstract":"

    Invited

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23collaborationExpirationyA2CmF":{"name":"collaborationExpiration","abstract":"

    Set collaborator expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24loginActivityDeviceAddedyA2CmF":{"name":"loginActivityDeviceAdded","abstract":"

    A user is logging in from a device we haven’t seen before.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26loginActivityDeviceRemovedyA2CmF":{"name":"loginActivityDeviceRemoved","abstract":"

    We invalidated a user session associated with an app.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO28userOAuth2AccessTokenCreatedyA2CmF":{"name":"userOAuth2AccessTokenCreated","abstract":"

    An OAuth 2.0 access token has been created

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20userAdminRoleChangedyA2CmF":{"name":"userAdminRoleChanged","abstract":"

    When an admin role changes for a user

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO35contentWorkflowUploadPolicyViolatedyA2CmF":{"name":"contentWorkflowUploadPolicyViolated","abstract":"

    A collaborator violated an admin-set upload policy

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataInstanceCreatedyA2CmF":{"name":"metadataInstanceCreated","abstract":"

    Creation of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23matadataInstanceUpdatedyA2CmF":{"name":"matadataInstanceUpdated","abstract":"

    Update of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23matadataInstanceDeletedyA2CmF":{"name":"matadataInstanceDeleted","abstract":"

    Deletion of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21taskAssignmentUpdatedyA2CmF":{"name":"taskAssignmentUpdated","abstract":"

    Update of a task assignment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21taskAssignmentDeletedyA2CmF":{"name":"taskAssignmentDeleted","abstract":"

    A task assignment is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11taskUpdatedyA2CmF":{"name":"taskUpdated","abstract":"

    A task’s comment was edited.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16itemAddedToGroupyA2CmF":{"name":"itemAddedToGroup","abstract":"

    An item is added to a group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20dataRetentionRemovedyA2CmF":{"name":"dataRetentionRemoved","abstract":"

    Retention is removed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20dataRetentionCreatedyA2CmF":{"name":"dataRetentionCreated","abstract":"

    Retention is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO34dataRetentionPolicyAssignmentAddedyA2CmF":{"name":"dataRetentionPolicyAssignmentAdded","abstract":"

    A retention policy assignment is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26legalHoldAssignmentCreatedyA2CmF":{"name":"legalHoldAssignmentCreated","abstract":"

    A legal hold assignment is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26legalHoldAssignmentDeletedyA2CmF":{"name":"legalHoldAssignmentDeleted","abstract":"

    A legal hold assignment is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyCreatedyA2CmF":{"name":"legalHoldPolicyCreated","abstract":"

    A legal hold policy is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyUpdatedyA2CmF":{"name":"legalHoldPolicyUpdated","abstract":"

    A legal hold policy is updated.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyDeletedyA2CmF":{"name":"legalHoldPolicyDeleted","abstract":"

    A legal hold policy is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22sharingPolicyViolationyA2CmF":{"name":"sharingPolicyViolation","abstract":"

    There is a sharing policy violation.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO25applicationPublicKeyAddedyA2CmF":{"name":"applicationPublicKeyAdded","abstract":"

    An application public key is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO27applicationPublicKeyDeletedyA2CmF":{"name":"applicationPublicKeyDeleted","abstract":"

    An application public key is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO18applicationCreatedyA2CmF":{"name":"applicationCreated","abstract":"

    A new application was created in the Box developer console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO18contentPolicyAddedyA2CmF":{"name":"contentPolicyAdded","abstract":"

    A content policy is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15automationAddedyA2CmF":{"name":"automationAdded","abstract":"

    An automation is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17automationDeletedyA2CmF":{"name":"automationDeleted","abstract":"

    An automation is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23userEmailAliasConfirmedyA2CmF":{"name":"userEmailAliasConfirmed","abstract":"

    A user email alias is confirmed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21userEmailAliasRemovedyA2CmF":{"name":"userEmailAliasRemoved","abstract":"

    A user email alias is removed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14watermarkAddedyA2CmF":{"name":"watermarkAdded","abstract":"

    A watermark is added to a file.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16watermarkRemovedyA2CmF":{"name":"watermarkRemoved","abstract":"

    A watermark is removed from a file.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateCreatedyA2CmF":{"name":"metadataTemplateCreated","abstract":"

    Creation of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateUpdatedyA2CmF":{"name":"metadataTemplateUpdated","abstract":"

    Update of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateDeletedyA2CmF":{"name":"metadataTemplateDeleted","abstract":"

    Deletion of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemOpenedyA2CmF":{"name":"itemOpened","abstract":"

    Item was opened.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12itemModifiedyA2CmF":{"name":"itemModified","abstract":"

    Item was modified.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24abnormalDownloadActivityyA2CmF":{"name":"abnormalDownloadActivity","abstract":"

    When a policy set in the Admin console is triggered.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21itemsRemovedFromGroupyA2CmF":{"name":"itemsRemovedFromGroup","abstract":"

    Folders were removed from a group in the Admin console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17itemsAddedToGroupyA2CmF":{"name":"itemsAddedToGroup","abstract":"

    Folders were added to a group in the Admin console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO25watermarkedFileDownloadedyA2CmF":{"name":"watermarkedFileDownloaded","abstract":"

    A watermarked file was downloaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom event type, that is not yet implemented in this SDK version.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of sync state.

    ","parent_name":"EventType"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO9ascendingyA2CmF":{"name":"ascending","abstract":"

    Items sorted in ascending order.

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO10descendingyA2CmF":{"name":"descending","abstract":"

    Items sorted in descending order.

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"OrderDirection"},"Enums/CommentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO7commentyAcA0C0CcACmF":{"name":"comment(_:)","abstract":"

    Comment type

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Debug description of an object

    ","parent_name":"CommentItem"},"Enums/CollaborationItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO6folderyAcA6FolderCcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Debug description of an object

    ","parent_name":"CollaborationItem"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO7inboundyA2CmF":{"name":"inbound","abstract":"

    Inbound collaboration direction

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO8outboundyA2CmF":{"name":"outbound","abstract":"

    Outbound collaboration direction

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO4bothyA2CmF":{"name":"both","abstract":"

    Bi-directional collaboration

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom scope for metadata template.

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"CollaborationDirection"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO6editoryA2CmF":{"name":"editor","abstract":"

    Editor role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO6vieweryA2CmF":{"name":"viewer","abstract":"

    Viewer role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO9previeweryA2CmF":{"name":"previewer","abstract":"

    Previewer rle

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO8uploaderyA2CmF":{"name":"uploader","abstract":"

    Uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO17previewerUploaderyA2CmF":{"name":"previewerUploader","abstract":"

    Preview uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO14viewerUploaderyA2CmF":{"name":"viewerUploader","abstract":"

    Viewer uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO7coOwneryA2CmF":{"name":"coOwner","abstract":"

    Co-owner role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO5owneryA2CmF":{"name":"owner","abstract":"

    Owner role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value of a role that was not yet implemented in this versison of SDK.

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO11descriptionSSvp":{"name":"description","abstract":"

    String representation of role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO8acceptedyA2CmF":{"name":"accepted","abstract":"

    Collaboration invitation accepted

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO7pendingyA2CmF":{"name":"pending","abstract":"

    Collaboration invitation is pending

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Collaboration invitation was rejected

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Collaboration invitation status of custom value that was not yet implemented in this version of SDK.

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO11descriptionSSvp":{"name":"description","abstract":"

    String representation of collaboration status.

    ","parent_name":"CollaborationStatus"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterO5valueyACyxGxcAEmlF":{"name":"value(_:)","abstract":"

    Specifies value that should be set to a parameter

    ","parent_name":"NullableParameter"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterO4nullyACyxGAEmlF":{"name":"null","abstract":"

    Empty value representing null

    ","parent_name":"NullableParameter"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterOAASERzlE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

    Encode the nullable parameter to either null or its encoded value

    ","parent_name":"NullableParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO6offsetyACSicACmF":{"name":"offset(_:)","abstract":"

    Offset

    ","parent_name":"PagingParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO6markeryACSSSgcACmF":{"name":"marker(_:)","abstract":"

    Marker

    ","parent_name":"PagingParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO14streamPositionyACSSSgcACmF":{"name":"streamPosition(_:)","abstract":"

    Stream position

    ","parent_name":"PagingParameter"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO7coadminyA2CmF":{"name":"coadmin","abstract":"

    Coadmin role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO5adminyA2CmF":{"name":"admin","abstract":"

    Admin role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO4useryA2CmF":{"name":"user","abstract":"

    User role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom role that is not yet implemented

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of user’s role.

    ","parent_name":"UserRole"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO6activeyA2CmF":{"name":"active","abstract":"

    User is active

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO8inactiveyA2CmF":{"name":"inactive","abstract":"

    User is inactive

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO18cannotDeleteOrEdityA2CmF":{"name":"cannotDeleteOrEdit","abstract":"

    User cannot delete or edit content

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO24cannotDeleteEditOrUploadyA2CmF":{"name":"cannotDeleteEditOrUpload","abstract":"

    User cannot delete, edit or upload content

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom user status that is not yet implemented

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of user status.

    ","parent_name":"UserStatus"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO7managedyA2CmF":{"name":"managed","abstract":"

    The ToS is allowed to be accepted/rejected by managed users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO8externalyA2CmF":{"name":"external","abstract":"

    The ToS is allowed to be accepted/rejected by external users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of scope of the ToS to the end users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO7enabledyA2CmF":{"name":"enabled","abstract":"

    The ToS is currently enabled and active.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO8disabledyA2CmF":{"name":"disabled","abstract":"

    The ToS is currently disabled and inactive.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO11descriptionSSvp":{"name":"description","abstract":"

    String representation of active/inactive indicator for ToS.

    ","parent_name":"TermsOfServiceStatus"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO4fileyA2CmF":{"name":"file","abstract":"

    Object type file

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO6folderyA2CmF":{"name":"folder","abstract":"

    Object type folder

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO7webLinkyA2CmF":{"name":"webLink","abstract":"

    Object type weblink

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type defined for searching that is not yet implemented.

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of searched item type.

    ","parent_name":"SearchItemType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO4nameyA2CmF":{"name":"name","abstract":"

    Searching in names of items

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11descriptionyA2CmF":{"name":"description","abstract":"

    Searching in description of items

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO12fileContentsyA2CmF":{"name":"fileContents","abstract":"

    Searching in files content

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO8commentsyA2CmF":{"name":"comments","abstract":"

    Searching in comments

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO4tagsyA2CmF":{"name":"tags","abstract":"

    Searching in tags

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom attribute defined for searching that is not yet implemented.

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of search area type

    ","parent_name":"SearchContentType"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO4useryA2CmF":{"name":"user","abstract":"

    Scope limited to current user

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    Scope limited the enterprise.

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom search scope that is not yet implemented. To enable this type of scope for an administrator,","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of scope.

    ","parent_name":"SearchScope"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO4noneyA2CmF":{"name":"none","abstract":"

    Preserve the existing value on the file

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO9overwriteyA2CmF":{"name":"overwrite","abstract":"

    Force-apply the cascade policy’s value over any existing value.

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom conflict resolution method.

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"ConflictResolution"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO2idyA2CmF":{"name":"id","abstract":"

    Order by item identifier

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4nameyA2CmF":{"name":"name","abstract":"

    Order by item name

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4dateyA2CmF":{"name":"date","abstract":"

    Order by item date

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4typeyA2CmF":{"name":"type","abstract":"

    Order by item type

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented by the SDk

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO4openyA2CmF":{"name":"open","abstract":"

    Any user can upload.

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO13collaboratorsyA2CmF":{"name":"collaborators","abstract":"

    Any folder collaborator can upload

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access to a folder’s upload email address that is not yet implemented.

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO11descriptionSSvp":{"name":"description","abstract":"

    Returns a string representation of the folder upload email access

    ","parent_name":"FolderUploadEmailAccess"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO3jpgyA2CmF":{"name":"jpg","abstract":"

    The file extension for Joint Photographic Experts Group (JPEG) thumbnail images

    ","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO3pngyA2CmF":{"name":"png","abstract":"

    The file extension for Portable Network Graphic (PNG) thumbnail images

    ","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom file extension for thumbnail images that is not yet implemented. Check the list of","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of suffix

    ","parent_name":"ThumbnailExtension"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO6activeyA2CmF":{"name":"active","abstract":"

    Item was not deleted or moved to trash.

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO7trashedyA2CmF":{"name":"trashed","abstract":"

    Item has been moved to the trash

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO7deletedyA2CmF":{"name":"deleted","abstract":"

    Item has been permanently deleted

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"ItemStatus"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO9newChangeyA2CmF":{"name":"newChange","abstract":"

    New event appeared.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO9reconnectyA2CmF":{"name":"reconnect","abstract":"

    No new events appeared. Request for a new polling URL.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Value that was not yet implemented in this SDK

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO11descriptionSSvp":{"name":"description","abstract":"

    String representation of the reponse.

    ","parent_name":"EventObserverResponse"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO3allyA2CmF":{"name":"all","abstract":"

    Stream returns all user events

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO7changesyA2CmF":{"name":"changes","abstract":"

    Stream returns events that may cause file tree changes such as file updates or collaborations

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO4syncyA2CmF":{"name":"sync","abstract":"

    Stream returns enterprise-wide events available for administrators

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom stream type that is not yet implemented

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of StreamType

    ","parent_name":"StreamType"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO3nowyA2CmF":{"name":"now","abstract":"

    When used, Box API will return 0 events and the latest streamPosition value to be used for subsequent call.

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO4zeroyA2CmF":{"name":"zero","abstract":"

    When used, Box API will return all available events.

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value of a stream position used when using value not yet implemented in this SDK (of similar usage as none, now or zero)

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of StreamPosition

    ","parent_name":"StreamPosition"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO4useryA2CmF":{"name":"user","abstract":"

    The user that is granted access

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO5groupyA2CmF":{"name":"group","abstract":"

    The group that is granted access

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access that is not yet implemented

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"AccessibleBy"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO12networkAgentyA2CmF":{"name":"networkAgent","abstract":"

    NetworkAgent related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO7modulesyA2CmF":{"name":"modules","abstract":"

    Module related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO6clientyA2CmF":{"name":"client","abstract":"

    BoxCLient related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO3sdkyA2CmF":{"name":"sdk","abstract":"

    The general log for BoxSDK

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO11descriptionSSvp":{"name":"description","abstract":"

    Log category string title

    ","parent_name":"LogCategory"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5debugyA2CmF":{"name":"debug","abstract":"

    Logging only while debugging

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO4infoyA2CmF":{"name":"info","abstract":"

    Logging info message

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5erroryA2CmF":{"name":"error","abstract":"

    Logging error

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5fatalyA2CmF":{"name":"fatal","abstract":"

    Logging fatal error

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO11descriptionSSvp":{"name":"description","abstract":"

    Log level string title

    ","parent_name":"LogLevel"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    The scope of the metadata template is set to the entire “enterprise”.

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO6globalyA2CmF":{"name":"global","abstract":"

    The scope of the metadata template is set to “global”

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom scope for metadata template.

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"MetadataScope"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO8lessThanyA2CmF":{"name":"lessThan","abstract":"

    Inclusive upper bound parameter for field values of floats and dates.

    ","parent_name":"MetadataFilterBound"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO11greaterThanyA2CmF":{"name":"greaterThan","abstract":"

    Inclusive lower bound parameter for field values of floats and dates.

    ","parent_name":"MetadataFilterBound"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO5equalyA2CmF":{"name":"equal","abstract":"

    Set the filter value equal to filter key.

    ","parent_name":"MetadataFilterBound"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO15clientDestroyedyA2CmF":{"name":"clientDestroyed","abstract":"

    Box client was destroyed

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO10invalidURLyACSS_tcACmF":{"name":"invalidURL(urlString:)","abstract":"

    URL is invalid

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO8notFoundyACSScACmF":{"name":"notFound(_:)","abstract":"

    The requested resource was not found

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19instanceDeallocatedyACSScACmF":{"name":"instanceDeallocated(_:)","abstract":"

    Object needed in closure was deallocated

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO27keychainDataConversionErroryA2CmF":{"name":"keychainDataConversionError","abstract":"

    Could not decode or encode keychain data

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO15keychainNoValueyA2CmF":{"name":"keychainNoValue","abstract":"

    Value not found in Keychain

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO22keychainUnhandledErroryACSScACmF":{"name":"keychainUnhandledError(_:)","abstract":"

    Unhandled keychain error

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19rateLimitMaxRetriesyA2CmF":{"name":"rateLimitMaxRetries","abstract":"

    Request has hit the maximum number of retries

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12typeMismatchyACSS_tcACmF":{"name":"typeMismatch(key:)","abstract":"

    Value for key is of an unexpected type

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO13valueMismatchyACSS_SSSaySSGtcACmF":{"name":"valueMismatch(key:value:acceptedValues:)","abstract":"

    Value for key is not one of the accepted values

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO18invalidValueFormatyACSS_tcACmF":{"name":"invalidValueFormat(key:)","abstract":"

    Value for key is of a valid type, but was not able to convert value to expected type

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO10notPresentyACSS_tcACmF":{"name":"notPresent(key:)","abstract":"

    Key was not present

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO28representationCreationFailedyA2CmF":{"name":"representationCreationFailed","abstract":"

    The file representation couldn’t be made

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO17tokenStoreFailureyA2CmF":{"name":"tokenStoreFailure","abstract":"

    Error with TokenStore operation (write, read or clear)

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO14tokenRetrievalyA2CmF":{"name":"tokenRetrieval","abstract":"

    Unsuccessful token retrieval. Token not found

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO33invalidOAuthRedirectConfigurationyA2CmF":{"name":"invalidOAuthRedirectConfiguration","abstract":"

    OAuth web session authorization failed due to invalid redirect configuration

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO17invalidOAuthStateyA2CmF":{"name":"invalidOAuthState","abstract":"

    Couldn’t obtain authorization code from OAuth web session result

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO18unauthorizedAccessyA2CmF":{"name":"unauthorizedAccess","abstract":"

    Unauthorized request to API

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO20refreshTokenNotFoundyA2CmF":{"name":"refreshTokenNotFound","abstract":"

    Unsuccessful refresh token retrieval. Token not found in the retrieved TokenInfo object

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12expiredTokenyA2CmF":{"name":"expiredToken","abstract":"

    Access token has expired

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12jwtAuthErroryA2CmF":{"name":"jwtAuthError","abstract":"

    Authorization with JWT token failed

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19nonIterableResponseyA2CmF":{"name":"nonIterableResponse","abstract":"

    Couldn’t create paging iterable for non-paged response

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO9endOfListyA2CmF":{"name":"endOfList","abstract":"

    The end of the list was reached

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom error message

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:s26ExpressibleByStringLiteralP06stringD0x0cD4TypeQz_tcfc":{"name":"init(stringLiteral:)","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html":{"name":"BoxSDKErrorEnum","abstract":"

    Box SDK Error

    "},"Enums/MetadataFilterBound.html":{"name":"MetadataFilterBound","abstract":"

    Defines the the relation between the filter key and filter value of a metadata template.

    "},"Enums/MetadataScope.html":{"name":"MetadataScope","abstract":"

    Defines the scope of the metadata template.

    "},"Enums/LogLevel.html":{"name":"LogLevel","abstract":"

    Defines character of the log and when it will be displayed

    "},"Enums/LogCategory.html":{"name":"LogCategory","abstract":"

    Defines log category based on what kind of data is being logged

    "},"Enums/AccessibleBy.html":{"name":"AccessibleBy","abstract":"

    Specifies type of value that has granted access to an object.

    "},"Enums/StreamPosition.html":{"name":"StreamPosition","abstract":"

    Stream position used for stream pagination

    "},"Enums/StreamType.html":{"name":"StreamType","abstract":"

    Restricts the types of events returned.

    "},"Enums/EventObserverResponse.html":{"name":"EventObserverResponse","abstract":"

    Defines results for a request checking for new changes in user events

    "},"Enums/ItemStatus.html":{"name":"ItemStatus","abstract":"

    Box item status indicating whether this item is deleted or not.

    "},"Enums/ThumbnailExtension.html":{"name":"ThumbnailExtension","abstract":"

    Defines the file extension of a thumbnail image file.

    "},"Enums/FolderUploadEmailAccess.html":{"name":"FolderUploadEmailAccess","abstract":"

    Defines the level of access to upload a file to a folder via its upload email address

    "},"Enums/FolderItemsOrderBy.html":{"name":"FolderItemsOrderBy","abstract":"

    Defines by which parameter should list of box items be ordered.

    "},"Enums/ConflictResolution.html":{"name":"ConflictResolution","abstract":"

    The desired behavior for conflict-resolution if a template already exists on a given file or folder

    "},"Enums/SearchScope.html":{"name":"SearchScope","abstract":"

    Defines search scope

    "},"Enums/SearchContentType.html":{"name":"SearchContentType","abstract":"

    Defines the attributes for which the search should look for matches

    "},"Enums/SearchItemType.html":{"name":"SearchItemType","abstract":"

    Defines type of objects to include in the search results

    "},"Enums/TermsOfServiceStatus.html":{"name":"TermsOfServiceStatus","abstract":"

    Specifies whether the Terms of Service is currently active or inactive.

    "},"Enums/TermsOfServiceType.html":{"name":"TermsOfServiceType","abstract":"

    Specifies whether the ToS is managed by an enterprise or external to an enterprise.

    "},"Enums/UserStatus.html":{"name":"UserStatus","abstract":"

    Defines user status.

    "},"Enums/UserRole.html":{"name":"UserRole","abstract":"

    Defines user’s role within an enterprise

    "},"Enums/PagingParameter.html":{"name":"PagingParameter","abstract":"

    Stores offset, marker or stream position for the iterator

    "},"Enums/NullableParameter.html":{"name":"NullableParameter","abstract":"

    Type for updating optional parameters - parameters that can either have value of some type, or be nil."},"Enums/CollaborationStatus.html":{"name":"CollaborationStatus","abstract":"

    The status of the collaboration invitation.

    "},"Enums/CollaborationRole.html":{"name":"CollaborationRole","abstract":"

    The level of access granted. To see exactly which role has which permission, please look here

    "},"Enums/CollaborationDirection.html":{"name":"CollaborationDirection","abstract":"

    Direction of the collaboration

    "},"Enums/CollaborationItem.html":{"name":"CollaborationItem","abstract":"

    The file or folder that access is granted to by collaboration.

    "},"Enums/CommentItem.html":{"name":"CommentItem","abstract":"

    Item a comment was placed on

    "},"Enums/OrderDirection.html":{"name":"OrderDirection","abstract":"

    Order direction.

    "},"Enums/EventType.html":{"name":"EventType","abstract":"

    Defines user or enterprise event type

    "},"Enums/FileRepresentationHint.html":{"name":"FileRepresentationHint","abstract":"

    Defines the file type for the generated file representation

    "},"Enums/SyncState.html":{"name":"SyncState","abstract":"

    Defines whether folder will be synced by the Box sync clients or not.

    "},"Enums/FolderItem.html":{"name":"FolderItem","abstract":"

    Files, folders, or web links contained within a folder.

    "},"Enums/GroupInvitabilityLevel.html":{"name":"GroupInvitabilityLevel","abstract":"

    Specifies who can invite the group to collaborate on folders.

    "},"Enums/GroupMemberViewabilityLevel.html":{"name":"GroupMemberViewabilityLevel","abstract":"

    Specifies who can view the members of the group.

    "},"Enums/GroupRole.html":{"name":"GroupRole","abstract":"

    Specifies role of the user within a Group.

    "},"Enums/FileMetadataOperation.html":{"name":"FileMetadataOperation","abstract":"

    Operations on a file metadata

    "},"Enums/FolderMetadataOperation.html":{"name":"FolderMetadataOperation","abstract":"

    Operations on a folder metadata

    "},"Enums/MetadataTemplateOperation.html":{"name":"MetadataTemplateOperation","abstract":"

    Specifies opperations available on metadata template

    "},"Enums/RetentionPolicyType.html":{"name":"RetentionPolicyType","abstract":"

    The type of the retention policy.

    "},"Enums/DispositionAction.html":{"name":"DispositionAction","abstract":"

    The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    "},"Enums/RetentionPolicyStatus.html":{"name":"RetentionPolicyStatus","abstract":"

    The status of the retention policy.

    "},"Enums/RetentionPolicyAssignmentItemType.html":{"name":"RetentionPolicyAssignmentItemType","abstract":"

    Item type with task assignment.

    "},"Enums/TokenScope.html":{"name":"TokenScope","abstract":"

    Specifies permissions that define a token scope

    "},"Enums/SharedLinkAccess.html":{"name":"SharedLinkAccess","abstract":"

    Defines the level of access to the item by its shared link.

    "},"Enums/TaskCompletionRule.html":{"name":"TaskCompletionRule","abstract":"

    Defines the condition that will mark a task as complete

    "},"Enums/TaskAction.html":{"name":"TaskAction","abstract":"

    The action the task assignee will be prompted to perform

    "},"Enums/AssignmentStatus.html":{"name":"AssignmentStatus","abstract":"

    Status of assignment.

    "},"Enums/AssignmentState.html":{"name":"AssignmentState","abstract":"

    State of assignment.

    "},"Enums/TaskItem.html":{"name":"TaskItem","abstract":"

    Item a task is assigned to

    "},"Enums/WebhookItem.html":{"name":"WebhookItem","abstract":"

    Files, folders, or web links associated with a webhook.

    "},"Classes/KeychainTokenStore.html#/s:6BoxSDK18KeychainTokenStoreCACycfc":{"name":"init()","abstract":"

    Initializer method

    ","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP4read10completionyys6ResultOyAA0C4InfoCs5Error_pGc_tF":{"name":"read(completion:)","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP5write9tokenInfo10completionyAA0cG0C_ys6ResultOyyts5Error_pGctF":{"name":"write(tokenInfo:completion:)","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP5clear10completionyys6ResultOyyts5Error_pGc_tF":{"name":"clear(completion:)","parent_name":"KeychainTokenStore"},"Classes/SingleTokenSession.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","parent_name":"SingleTokenSession"},"Classes/SingleTokenSession.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","parent_name":"SingleTokenSession"},"Classes/SingleTokenSession.html#/s:6BoxSDK18SingleTokenSessionC09downscopeD05scope8resource10sharedLink10completionyShyAA0D5ScopeOG_SSSgALys6ResultOyAA0D4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"SingleTokenSession"},"Classes/OAuth2Session.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK20ExpiredTokenHandlingP06handlecD010completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"handleExpiredToken(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK13OAuth2SessionC12refreshToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"refreshToken(completion:)","abstract":"

    Gets refreshed access token if necessary

    ","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK13OAuth2SessionC14downscopeToken5scope8resource10sharedLink10completionyShyAA0F5ScopeOG_SSSgALys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"OAuth2Session"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","abstract":"

    Revokes token

    ","parent_name":"DelegatedAuthSession"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","abstract":"

    Retrieves valid access token

    ","parent_name":"DelegatedAuthSession"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC14downscopeToken5scope8resource10sharedLink10completionyShyAA0G5ScopeOG_SSSgALys6ResultOyAA0G4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"DelegatedAuthSession"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC14totalFileCountSivp":{"name":"totalFileCount","abstract":"

    The total number of files in the zip

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC19downloadedFileCountSivp":{"name":"downloadedFileCount","abstract":"

    The number of files in the zip that were downloaded

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC16skippedFileCountSivp":{"name":"skippedFileCount","abstract":"

    The number of files that were skipped when downloading

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC18skippedFolderCountSivp":{"name":"skippedFolderCount","abstract":"

    The number of folders that were skipped when downloading

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC5stateSSvp":{"name":"state","abstract":"

    State of the download for the zip file

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC13nameConflictsSayAA0cD8ConflictCGSgvp":{"name":"nameConflicts","abstract":"

    Conflicts that occur between items that have the same name. This is always initially nil and updated manually later, via the FilesModule.getZipDownloadStatus() method.

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC2idSSvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC4typeSSvp":{"name":"type","abstract":"

    Box item type - file or folder.

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC12originalNameSSvp":{"name":"originalName","abstract":"

    The original name of the item that has the conflict

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC12downloadNameSSvp":{"name":"downloadName","abstract":"

    The new name of the item when it downloads that resolves the conflict

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadConflict"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK19ZipDownloadConflictC8conflictSayAA0cdE4ItemCGSgvp":{"name":"conflict","abstract":"

    Conflict that occurs between items that have the same name.

    ","parent_name":"ZipDownloadConflict"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK19ZipDownloadConflictC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadConflict"},"Classes/ZipDownload.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC11downloadUrl10Foundation3URLVvp":{"name":"downloadUrl","abstract":"

    The URL to download the Zip file. If entered in a browser, this URL will trigger a download of the Zip file.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC9statusUrl10Foundation3URLVvp":{"name":"statusUrl","abstract":"

    The URL to monitor the status of the download.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    Expiration date of the Zip file download.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC13nameConflictsSayAA0cD8ConflictCGSgvp":{"name":"nameConflicts","abstract":"

    Conflicts that occur between items that have the same name.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownload"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileUploadedyA2EmF":{"name":"fileUploaded","abstract":"

    A file is uploaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13filePreviewedyA2EmF":{"name":"filePreviewed","abstract":"

    A file is previewed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14fileDownloadedyA2EmF":{"name":"fileDownloaded","abstract":"

    A file is downloaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileTrashedyA2EmF":{"name":"fileTrashed","abstract":"

    A file is moved to the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileDeletedyA2EmF":{"name":"fileDeleted","abstract":"

    A file is permanently deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileRestoredyA2EmF":{"name":"fileRestored","abstract":"

    A file is restored from the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO10fileCopiedyA2EmF":{"name":"fileCopied","abstract":"

    A file is copied

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO9fileMovedyA2EmF":{"name":"fileMoved","abstract":"

    A file is moved from one folder to another

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO10fileLockedyA2EmF":{"name":"fileLocked","abstract":"

    A file is locked

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileUnlockedyA2EmF":{"name":"fileUnlocked","abstract":"

    A file is unlocked

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileRenamedyA2EmF":{"name":"fileRenamed","abstract":"

    A file was renamed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentCreatedyA2EmF":{"name":"commentCreated","abstract":"

    A comment object is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentUpdatedyA2EmF":{"name":"commentUpdated","abstract":"

    A comment object is edited

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentDeletedyA2EmF":{"name":"commentDeleted","abstract":"

    A comment object is removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21taskAssignmentCreatedyA2EmF":{"name":"taskAssignmentCreated","abstract":"

    A task is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21taskAssignmentUpdatedyA2EmF":{"name":"taskAssignmentUpdated","abstract":"

    A task assignment is changed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceCreatedyA2EmF":{"name":"metadataInstanceCreated","abstract":"

    A new metadata template instance is associated with a file or folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceUpdatedyA2EmF":{"name":"metadataInstanceUpdated","abstract":"

    An attribute (value) is updated/deleted for an existing metadata template instance associated with a file or folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceDeletedyA2EmF":{"name":"metadataInstanceDeleted","abstract":"

    An existing metadata template instance associated with a file or folder is deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderCreatedyA2EmF":{"name":"folderCreated","abstract":"

    A folder is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderRenamedyA2EmF":{"name":"folderRenamed","abstract":"

    A folder was renamed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO16folderDownloadedyA2EmF":{"name":"folderDownloaded","abstract":"

    A folder is downloaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14folderRestoredyA2EmF":{"name":"folderRestored","abstract":"

    A folder is restored from the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderDeletedyA2EmF":{"name":"folderDeleted","abstract":"

    A folder is permanently removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12folderCopiedyA2EmF":{"name":"folderCopied","abstract":"

    A copy of a folder is made

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11folderMovedyA2EmF":{"name":"folderMoved","abstract":"

    A folder is moved to a different folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderTrashedyA2EmF":{"name":"folderTrashed","abstract":"

    A folder is moved to the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14webhookDeletedyA2EmF":{"name":"webhookDeleted","abstract":"

    When a webhook is deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationCreatedyA2EmF":{"name":"collaborationCreated","abstract":"

    A collaboration is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21collaborationAcceptedyA2EmF":{"name":"collaborationAccepted","abstract":"

    A collaboration has been accepted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21collaborationRejectedyA2EmF":{"name":"collaborationRejected","abstract":"

    A collaboration has been rejected

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationRemovedyA2EmF":{"name":"collaborationRemoved","abstract":"

    A collaboration has been removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationUpdatedyA2EmF":{"name":"collaborationUpdated","abstract":"

    A collaboration has been updated

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkDeletedyA2EmF":{"name":"sharedLinkDeleted","abstract":"

    A shared link was deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkCreatedyA2EmF":{"name":"sharedLinkCreated","abstract":"

    A shared link was created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkUpdatedyA2EmF":{"name":"sharedLinkUpdated","abstract":"

    A shared link was updated

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html":{"name":"EventTriggers","abstract":"

    Event triggers for webhooks

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC6targetAA0C4ItemOSgvp":{"name":"target","abstract":"

    Target information

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    User that created the webhook

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    Timestamp of when webhook was created

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC7address10Foundation3URLVSgvp":{"name":"address","abstract":"

    URL to which notifications are sent

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC8triggersSayAC13EventTriggersOGSgvp":{"name":"triggers","abstract":"

    Events that activate the webhook

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Webhook"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Can rename web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Can delete web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV10canCommentSbSgvp":{"name":"canComment","abstract":"

    Can comment on web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Can share web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Can set share access for web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html":{"name":"Permissions","abstract":"

    Web link permissions

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this web link. Used with If-Match headers.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4nameSSSgvp":{"name":"name","abstract":"

    The name of this web link.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    The URL this web link points to.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When this web link was created

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this web link was last updated

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    The parent object the web link belongs to.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC11descriptionSSSgvp":{"name":"description","abstract":"

    The description accompanying the web link. This is visible within the Box web application.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10itemStatusAA04ItemF0OSgvp":{"name":"itemStatus","abstract":"

    Status of the web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When this web link was last moved to the trash

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When this web link will be permanently deleted.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC06sharedD0AA06SharedD0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this web link. Is nil if no shared link has been created.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC14pathCollectionAA04PathF0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this link, starting at the root

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last modified this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Web link permissions

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"WebLink"},"Classes/Watermark.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC11resourceKeySSvpZ":{"name":"resourceKey","abstract":"

    Key for watermark data JSON object

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC10imprintKeySSvpZ":{"name":"imprintKey","abstract":"

    Key for imprint data in JSON object

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC14defaultImprintSSvpZ":{"name":"defaultImprint","abstract":"

    Default imprint text

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time this watermark was created.

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time this watermark was last modified.

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Watermark"},"Classes/User/TrackingCode.html#/s:6BoxSDK4UserC12TrackingCodeV4nameSSvp":{"name":"name","abstract":"

    Code name

    ","parent_name":"TrackingCode"},"Classes/User/TrackingCode.html#/s:6BoxSDK4UserC12TrackingCodeV5valueSSvp":{"name":"value","abstract":"

    Code value

    ","parent_name":"TrackingCode"},"Classes/User/TrackingCode.html":{"name":"TrackingCode","abstract":"

    A custom values set by the user’s admin to track user’s activity.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4nameSSSgvp":{"name":"name","abstract":"

    The name of the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC5loginSSSgvp":{"name":"login","abstract":"

    The email address the user uses to log in.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the user object was created.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the user object was last modified.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8languageSSSgvp":{"name":"language","abstract":"

    The user’s preferred language.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8timezoneSSSgvp":{"name":"timezone","abstract":"

    The user’s timezone.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC11spaceAmountSiSgvp":{"name":"spaceAmount","abstract":"

    The user’s total available space amount in bytes.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9spaceUsedSiSgvp":{"name":"spaceUsed","abstract":"

    The amount of space in use by the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13maxUploadSizeSiSgvp":{"name":"maxUploadSize","abstract":"

    The maximum individual file size in bytes the user can have.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC6statusAA0C6StatusOSgvp":{"name":"status","abstract":"

    User’s status.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8jobTitleSSSgvp":{"name":"jobTitle","abstract":"

    The user’s job title.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC5phoneSSSgvp":{"name":"phone","abstract":"

    The user’s phone number.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC7addressSSSgvp":{"name":"address","abstract":"

    The user’s address.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9avatarUrl10Foundation3URLVSgvp":{"name":"avatarUrl","abstract":"

    URL of the user’s avatar image.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4roleSSSgvp":{"name":"role","abstract":"

    The user’s enterprise role.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13trackingCodesSayAC12TrackingCodeVGSgvp":{"name":"trackingCodes","abstract":"

    An array of key/value pairs set by the user’s admin.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC18canSeeManagedUsersSbSgvp":{"name":"canSeeManagedUsers","abstract":"

    Whether the user can see other enterprise users in their contact list.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13isSyncEnabledSbSgvp":{"name":"isSyncEnabled","abstract":"

    Whether the user can use Box Sync.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC26isExternalCollabRestrictedSbSgvp":{"name":"isExternalCollabRestricted","abstract":"

    Whether the user is allowed to collaborate with users outside her enterprise.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC24isExemptFromDeviceLimitsSbSgvp":{"name":"isExemptFromDeviceLimits","abstract":"

    Whether to exempt the user from Enterprise device limits.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC29isExemptFromLoginVerificationSbSgvp":{"name":"isExemptFromLoginVerification","abstract":"

    Whether the user must use two-factor authentication.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the user’s enterprise.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC6myTagsSaySSGSgvp":{"name":"myTags","abstract":"

    Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8hostnameSSSgvp":{"name":"hostname","abstract":"

    The root (protocol, subdomain, domain) of any links that need to be generated for the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC20isPlatformAccessOnlySbSgvp":{"name":"isPlatformAccessOnly","abstract":"

    Whether the user is an App User.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC011externalAppC2IdSSSgvp":{"name":"externalAppUserId","abstract":"

    External app user ID.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"User"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV9listParts10Foundation3URLVSgvp":{"name":"listParts","abstract":"

    List parts endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV6commit10Foundation3URLVSgvp":{"name":"commit","abstract":"

    Commit part endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV8logEvent10Foundation3URLVSgvp":{"name":"logEvent","abstract":"

    Log event endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV10uploadPart10Foundation3URLVSgvp":{"name":"uploadPart","abstract":"

    Upload part endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV6status10Foundation3URLVSgvp":{"name":"status","abstract":"

    Upload status endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV5abort10Foundation3URLVSgvp":{"name":"abort","abstract":"

    Abort upload endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html":{"name":"UploadSessionEndpoints","abstract":"

    Internal struct containing URLs for upload session manipulation

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC10totalPartsSivp":{"name":"totalParts","abstract":"

    Count of uploaded parts

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC8partSizeSivp":{"name":"partSize","abstract":"

    Size of uploaded part. Each part’s size must be exactly equal in size to the part size specified","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC17numPartsProcessedSivp":{"name":"numPartsProcessed","abstract":"

    Number of parts processed

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC16sessionExpiresAt10Foundation4DateVvp":{"name":"sessionExpiresAt","abstract":"

    The validity end of this session

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC16sessionEndpointsAC0cdF0Vvp":{"name":"sessionEndpoints","abstract":"

    Set of URL for upload session management

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"UploadSession"},"Classes/UploadPart.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"UploadPart"},"Classes/UploadPart.html#/s:6BoxSDK10UploadPartC4partAA0cD11DescriptionVvp":{"name":"part","abstract":"

    Part description object

    ","parent_name":"UploadPart"},"Classes/UploadPart.html#/s:6BoxSDK10UploadPartC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"UploadPart"},"Classes/TrackingCode.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC4nameSSvp":{"name":"name","abstract":"

    Tracking code key.

    ","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC5valueSSvp":{"name":"value","abstract":"

    Tracking code value.

    ","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TrackingCode"},"Classes/TokenInfo.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC06accessC007refreshC09expiresIn9tokenTypeACSS_SSSgSdSStcfc":{"name":"init(accessToken:refreshToken:expiresIn:tokenType:)","abstract":"

    Initializer

    ","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC06accessC09expiresInACSS_Sdtcfc":{"name":"init(accessToken:expiresIn:)","abstract":"

    Initializer.

    ","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compares tokens

    ","parent_name":"TokenInfo"},"Classes/Token.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC06accessC0SSSgvp":{"name":"accessToken","abstract":"

    Access token.

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC9expiresInSiSgvp":{"name":"expiresIn","abstract":"

    Expiration time interval since

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC9tokenTypeSSSgvp":{"name":"tokenType","abstract":"

    Type of token

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC12restrictedToSayAA5ScopeCGSgvp":{"name":"restrictedTo","abstract":"

    Token permissions

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Token"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC2idSSvp":{"name":"id","abstract":"

    The ID of the user status object for the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC3tosAA0cdE0CSgvp":{"name":"tos","abstract":"

    The Terms of Service this status is associated with.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4userAA0F0CSgvp":{"name":"user","abstract":"

    The user that is associated with the current status of the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC10isAcceptedSbSgvp":{"name":"isAccepted","abstract":"

    Indicator as to whether or not the user has accepted the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date the user status for the ToS was created.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date the user status for the ToS was modified.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC6statusAA0cdE6StatusOSgvp":{"name":"status","abstract":"

    An enum indicating whether the ToS is currently active or inactive.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    A mini Box enterprise object that the ToS is associated with.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC7tosTypeAA0cdeG0OSgvp":{"name":"tosType","abstract":"

    The scope of the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4textSSSgvp":{"name":"text","abstract":"

    The agreement of the ToS specified for the user in the custom application.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date created at for the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date modified at for the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfService"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    File an assignment is on.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    Date of assignment.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC6statusAA0D6StatusOSgvp":{"name":"status","abstract":"

    Assignment status.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC7messageSSSgvp":{"name":"message","abstract":"

    A message from the assignee about this task.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedToAA4UserCSgvp":{"name":"assignedTo","abstract":"

    The user task is assigned to.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    The user task is assigned by.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC15resolutionStateAA0dF0OSgvp":{"name":"resolutionState","abstract":"

    State of assignment. Can be completed, incomplete, approved, or rejected.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TaskAssignment"},"Classes/Task.html#/s:6BoxSDK4TaskC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The file associated with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC5dueAt10Foundation4DateVSgvp":{"name":"dueAt","abstract":"

    When the task is due.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC6actionAA0C6ActionOSgvp":{"name":"action","abstract":"

    The action the task assignee will be prompted to do. Depending on task type, this can be “review” or “complete”.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC7messageSSSgvp":{"name":"message","abstract":"

    A message that will be included with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC24taskAssignmentCollectionAA14EntryContainerCyAA0cE0CGSgvp":{"name":"taskAssignmentCollection","abstract":"

    A collection of mini task_assignment objects associated with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC11isCompletedSbSgvp":{"name":"isCompleted","abstract":"

    Whether the task has been completed.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the task object was created.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC14completionRuleAA0c10CompletionE0OSgvp":{"name":"completionRule","abstract":"

    The rule that determines whether a task is completed

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Task"},"Classes/StoragePolicyAssignment/AssignedTo.html#/s:6BoxSDK23StoragePolicyAssignmentC10AssignedToV4typeSSvp":{"name":"type","abstract":"

    Type of item storage policy is assigned to

    ","parent_name":"AssignedTo"},"Classes/StoragePolicyAssignment/AssignedTo.html#/s:6BoxSDK23StoragePolicyAssignmentC10AssignedToV2idSSvp":{"name":"id","abstract":"

    Id of item storage policy is assigned to

    ","parent_name":"AssignedTo"},"Classes/StoragePolicyAssignment/AssignedTo.html":{"name":"AssignedTo","abstract":"

    Enterprise storage policy is assigned to

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Id of the storage policy assignment

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC07storageD0AA0cD0CSgvp":{"name":"storagePolicy","abstract":"

    Storage policy

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC10assignedToAC08AssignedG0VSgvp":{"name":"assignedTo","abstract":"

    Enterprise the storage policy is assigned to

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC2idSSvp":{"name":"id","abstract":"

    Id of the storage policy

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4nameSSSgvp":{"name":"name","abstract":"

    Name for a storage zone

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StoragePolicy"},"Classes/SharedLink/Permissions.html#/s:6BoxSDK10SharedLinkC11PermissionsV10canPreviewSbSgvp":{"name":"canPreview","abstract":"

    Whether the shared link allows previewing. For shared links on folders, this also applies to any items in the folder.

    ","parent_name":"Permissions"},"Classes/SharedLink/Permissions.html#/s:6BoxSDK10SharedLinkC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Whether the shared link allows downloads. For shared links on folders, this also applies to any items in the folder.

    ","parent_name":"Permissions"},"Classes/SharedLink/Permissions.html":{"name":"Permissions","abstract":"

    Permission for a user accessing item by shared link

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    The URL to access the item on Box. If entered in a browser, this URL will display the item in Box’s preview UI.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC11downloadURL10Foundation0F0VSgvp":{"name":"downloadURL","abstract":"

    The “direct Link” URL to download the item. If entered in a browser, this URL will trigger a download of the item.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC9vanityURL10Foundation0F0VSgvp":{"name":"vanityURL","abstract":"

    The “Custom URL” that can also be used to preview the item on Box.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC15effectiveAccessSSSgvp":{"name":"effectiveAccess","abstract":"

    The effective access level for the shared link. This can be lower than the value in the access field","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC19effectivePermissionSSSgvp":{"name":"effectivePermission","abstract":"

    Actual permissions that are allowed by the shared link, taking into account enterprise and user settings.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC17isPasswordEnabledSbSgvp":{"name":"isPasswordEnabled","abstract":"

    Whether the shared link has a password set.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC10unsharedAt10Foundation4DateVSgvp":{"name":"unsharedAt","abstract":"

    The date-time that this link will become disabled. This field can only be set by users with paid accounts.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC13downloadCountSiSgvp":{"name":"downloadCount","abstract":"

    The number of times the item has been downloaded.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC12previewCountSiSgvp":{"name":"previewCount","abstract":"

    The number of times the item has been previewed.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC6accessAA0cD6AccessOSgvp":{"name":"access","abstract":"

    The access level specified when the shared link was created.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Permissions for download and preview of the item.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SharedLink"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"SharedItemType"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"SharedItemType"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO7webLinkyAeA03WebG0CcAEmF":{"name":"webLink(_:)","abstract":"

    Web link type

    ","parent_name":"SharedItemType"},"Classes/SharedItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SharedItem"},"Classes/SharedItem/SharedItemType.html":{"name":"SharedItemType","abstract":"

    Type of shared item

    ","parent_name":"SharedItem"},"Classes/SharedItem.html#/s:6BoxSDK10SharedItemC9itemValueAC0cD4TypeOvp":{"name":"itemValue","abstract":"

    Shared item value

    ","parent_name":"SharedItem"},"Classes/SharedItem.html#/s:6BoxSDK10SharedItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SharedItem"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC23accessibleViaSharedLink10Foundation3URLVSgvp":{"name":"accessibleViaSharedLink","abstract":"

    The optional shared link through which the user has access to this item.","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4itemAA10FolderItemOvp":{"name":"item","abstract":"

    The file, folder or web link that matched the search query.

    ","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SearchResult"},"Classes/Scope.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC5scopeSSSgvp":{"name":"scope","abstract":"

    Scope permission

    ","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC6objectAA4FileCSgvp":{"name":"object","abstract":"

    The file scope is applied to

    ","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Scope"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC4nameSSSgvp":{"name":"name","abstract":"

    The name of the retention policy.

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC2idSSSgvp":{"name":"id","abstract":"

    ID of the content that is under retention.","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC4typeAA0cdeF4TypeOSgvp":{"name":"type","abstract":"

    Type of the content that is under retention.

    ","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC09retentionD0AA0cD0CSgvp":{"name":"retentionPolicy","abstract":"

    A mini retention policy object representing the retention policy that has been assigned to this content.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedToAA0cdE4ItemCSgvp":{"name":"assignedTo","abstract":"

    Content that is under retention. The type can either be folder or enterprise.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    A mini user object representing the user that created the retention policy assignment object.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    When the retention policy assignment object was created.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC12filterFieldsSayAA19MetadataFieldFilterVGSgvp":{"name":"filterFields","abstract":"

    The array of metadata field filters, if present

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC4nameSSSgvp":{"name":"name","abstract":"

    The name of the retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC10policyTypeAA0cdF0OSgvp":{"name":"policyType","abstract":"

    The type of the retention policy based on whether the amount of time to retain content is known or unknown.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC15retentionLengthSiSgvp":{"name":"retentionLength","abstract":"

    The length of the retention policy. This length specifies the duration in days that the retention policy will be active","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC17dispositionActionAA011DispositionF0OSgvp":{"name":"dispositionAction","abstract":"

    The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC6statusAA0cD6StatusOSgvp":{"name":"status","abstract":"

    The status of the retention policy. Can be either active or retired. Once a policy has been retired, it cannot become active again.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    A mini user object representing the user that created the retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the retention policy object was created.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the retention policy object was last modified.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC014canOwnerExtendC0SbSgvp":{"name":"canOwnerExtendRetention","abstract":"

    Wheter owner can extend time of retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC17areOwnersNotifiedSbSgvp":{"name":"areOwnersNotified","abstract":"

    Whether owners are notified about retention policy changes.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC28customNotificationRecipientsSayAA4UserCGSgvp":{"name":"customNotificationRecipients","abstract":"

    Other users notified about retention policy changes.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicy"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11itemPreviewyA2EmF":{"name":"itemPreview","abstract":"

    Item was previewd

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO10itemUploadyA2EmF":{"name":"itemUpload","abstract":"

    Item was uploaded

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11itemCommentyA2EmF":{"name":"itemComment","abstract":"

    Item was commented on

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO8itemOpenyA2EmF":{"name":"itemOpen","abstract":"

    Item was opened

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO10itemModifyyA2EmF":{"name":"itemModify","abstract":"

    Item was modified

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html":{"name":"InteractionType","abstract":"

    Interaction type with item

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC15interactionTypeAC011InteractionF0Ovp":{"name":"interactionType","abstract":"

    Type of interation

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC12interactedAt10Foundation4DateVvp":{"name":"interactedAt","abstract":"

    Timestamp of the interactions

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4itemAA4FileCvp":{"name":"item","abstract":"

    The item

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC21interactionSharedLinkSSSgvp":{"name":"interactionSharedLink","abstract":"

    Shared link of interaction

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"RecentItem"},"Classes/PollingURLInfo.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC3url10Foundation3URLVvp":{"name":"url","abstract":"

    URL value for checking for new events.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC16timeoutInSecondsSivp":{"name":"timeoutInSeconds","abstract":"

    Timeout in seconds after which request for new changes should be repeated.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC10maxRetriesSSvp":{"name":"maxRetries","abstract":"

    Maximum number of retries in case of failed request for new changes.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PollingURLInfo"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    Box item type

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7versionSivp":{"name":"version","abstract":"

    Version

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7messageAA21EventObserverResponseOvp":{"name":"message","abstract":"

    Message specifying type of the response.

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PollingResult"},"Classes/PathCollection.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of entries in a path

    ","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC7entriesSayAA6FolderCGSgvp":{"name":"entries","abstract":"

    Entries (folders) in a path to an item

    ","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PathCollection"},"Classes/MetadataTemplate.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC2idSSSgvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC11templateKeySSSgvp":{"name":"templateKey","abstract":"

    A unique identifier for the template. The identifier must be unique across the scope of the enterprise to which the metadata template is being applied.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC5scopeSSSgvp":{"name":"scope","abstract":"

    The scope of the object. Global and enterprise scopes are supported.","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC11displayNameSSSgvp":{"name":"displayName","abstract":"

    The display name of the template.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC6hiddenSbSgvp":{"name":"hidden","abstract":"

    Whether this template is hidden in the UI.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC22copyInstanceOnItemCopySbSgvp":{"name":"copyInstanceOnItemCopy","abstract":"

    Whether or not to copy any metadata attached to a file or folder when it is copied. By default, metadata is not copied along with a file or folder when it is copied.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC6fieldsSayAA0C5FieldVGSgvp":{"name":"fields","abstract":"

    The ordered set of key:value pairs for the template.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataObject.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC2idSSSgvp":{"name":"id","abstract":"

    Identifier.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC8templateSSSgvp":{"name":"template","abstract":"

    The key of the template.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC5scopeSSSgvp":{"name":"scope","abstract":"

    The scope of the object. global and enterprise scopes are supported. The global scope contains the properties template,","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC6parentSSSgvp":{"name":"parent","abstract":"

    The ID of the object the metadata object belongs to. Both file and folder objects are supported.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC7versionSiSgvp":{"name":"version","abstract":"

    The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4typeSSSgvp":{"name":"type","abstract":"

    A unique identifier for the “type” of this instance.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC11typeVersionSiSgvp":{"name":"typeVersion","abstract":"

    The last-known version of the template of the object.","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4keysSDySSypGvp":{"name":"keys","abstract":"

    Custom value(s) defined by the template. These values also have a corresponding display name","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataObject"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC4typeSSvp":{"name":"type","abstract":"

    Object type.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC2idSSvp":{"name":"id","abstract":"

    Identifier.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC15ownerEnterpriseAA0G0CSgvp":{"name":"ownerEnterprise","abstract":"

    The enterprise that owns the policy.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    Represent the parent of the policy and the metadata instance to cascade down.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC5scopeAA0C5ScopeOSgvp":{"name":"scope","abstract":"

    The scope of the target instance that will be cascaded down. The scope & templateKey together identify","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC11templateKeySSSgvp":{"name":"templateKey","abstract":"

    The template key of the target metadata template to cascade down. The scope & templateKey together identify","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataCascadePolicy"},"Classes/Lock.html#/s:6BoxSDK4LockC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    Who created the lock.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When was lock created.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When lock expires.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC19isDownloadPreventedSbSgvp":{"name":"isDownloadPrevented","abstract":"

    Whether or not the file can be downloaded while locked.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Lock"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    FIle type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO11fileVersionyAeA04FileJ0CcAEmF":{"name":"fileVersion(_:)","abstract":"

    File version type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html":{"name":"AssignmentItemType","abstract":"

    Type of item legal hold policy was assigned to

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC9itemValueAC0fG4TypeOvp":{"name":"itemValue","abstract":"

    Item that the legal hold policy is assigned to

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC05legaldE0AA0cdE0CSgvp":{"name":"legalHoldPolicy","abstract":"

    The policy that the legal hold policy assignment is part of.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedToAA0cdeF4ItemCSgvp":{"name":"assignedTo","abstract":"

    The entity that the legal hold policy assignment is assigned to.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    The user who created the legal hold policy assignment.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    When the legal hold policy assignment object was created.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    When the assignment release request was sent.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO6activeyA2EmF":{"name":"active","abstract":"

    The policy is not in a transition state

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO8applyingyA2EmF":{"name":"applying","abstract":"

    That the policy is in the process of being applied

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO9releasingyA2EmF":{"name":"releasing","abstract":"

    That the process is in the process of being released

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO8releasedyA2EmF":{"name":"released","abstract":"

    The policy is no longer active

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"Status"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV4userSivp":{"name":"user","abstract":"

    Number of assigned users

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV6folderSivp":{"name":"folder","abstract":"

    Number of assigned folders

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV4fileSivp":{"name":"file","abstract":"

    Number of assigned files

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV11fileVersionSivp":{"name":"fileVersion","abstract":"

    Number of assigned file verions

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html":{"name":"AssignmentCounts","abstract":"

    Counts of the assignments to different entities of this policy

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy/Status.html":{"name":"Status","abstract":"

    Status of legal hold policy

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC10policyNameSSSgvp":{"name":"policyName","abstract":"

    Name of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC11descriptionSSSgvp":{"name":"description","abstract":"

    Description of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC6statusAC6StatusOSgvp":{"name":"status","abstract":"

    Status of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC16assignmentCountsAC010AssignmentG0VSgvp":{"name":"assignmentCounts","abstract":"

    Counts of assignments within this policy by apply-to type.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the legal hold policy object.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the legal hold policy object was created.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the legal hold policy object was modified.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    When the policy release request was sent.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC15filterStartedAt10Foundation4DateVSgvp":{"name":"filterStartedAt","abstract":"

    User-specified, optional date filter applies to Custodian assignments only.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC13filterEndedAt10Foundation4DateVSgvp":{"name":"filterEndedAt","abstract":"

    User-specified, optional date filter applies to Custodian assignments only.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC12releaseNotesSSSgvp":{"name":"releaseNotes","abstract":"

    Notes about why the policy was released.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicy"},"Classes/Invite.html#/s:6BoxSDK6InviteC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9invitedToAA10EnterpriseCSgvp":{"name":"invitedTo","abstract":"

    Enterprise object user is invited to.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC12actionableByAA4UserCSgvp":{"name":"actionableBy","abstract":"

    The user who was invited to the enterprise

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9invitedByAA4UserCSgvp":{"name":"invitedBy","abstract":"

    User who created the invitation.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC6statusSSSgvp":{"name":"status","abstract":"

    Invitation status

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When invitation was created.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When invitation was updated.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Invite"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV13canRunReportsSbvp":{"name":"canRunReports","abstract":"

    Group can run reports

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV15canInstantLoginSbvp":{"name":"canInstantLogin","abstract":"

    Group can login instantly

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV17canCreateAccountsSbvp":{"name":"canCreateAccounts","abstract":"

    Group can create accounts

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV15canEditAccountsSbvp":{"name":"canEditAccounts","abstract":"

    Group can edit accounts

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html":{"name":"ConfigurablePermissions","abstract":"

    Permissions of group membership

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC2idSSvp":{"name":"id","abstract":"

    The ID of the association between a user and a group.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4userAA4UserCSgvp":{"name":"user","abstract":"

    A user object associated with the group.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC5groupAA0C0CSgvp":{"name":"group","abstract":"

    The group the user is associated with.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4roleAA0C4RoleOSgvp":{"name":"role","abstract":"

    The role of the user within the group. The default is member with an option for admin.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC23configurablePermissionsAC012ConfigurableF0VSgvp":{"name":"configurablePermissions","abstract":"

    Permissions of an individual group member.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date time this membership was created at.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date time this membership was modified at.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"GroupMembership"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO07managedC0yA2EmF":{"name":"managedGroup","abstract":"

    Group is managed by the Enterprise admin

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO08allUsersC0yA2EmF":{"name":"allUsersGroup","abstract":"

    A Box-defined group that includes all users in an Enterprise

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this SDK.

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"GroupType"},"Classes/Group/GroupType.html":{"name":"GroupType","abstract":"

    The type of the group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC2idSSvp":{"name":"id","abstract":"

    The ID of the group object.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4nameSSSgvp":{"name":"name","abstract":"

    The name of the group

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC9groupTypeAC0cE0OSgvp":{"name":"groupType","abstract":"

    The type of the group

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the group object was created.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the group object was last modified.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC10provenanceSSSgvp":{"name":"provenance","abstract":"

    Keeps track of which external source this group is coming.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC11descriptionSSSgvp":{"name":"description","abstract":"

    Human readable description of the group. This can be up to 255 characters long

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC22externalSyncIdentifierSSSgvp":{"name":"externalSyncIdentifier","abstract":"

    An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC17invitabilityLevelAA0c12InvitabilityE0OSgvp":{"name":"invitabilityLevel","abstract":"

    Specifies who can invite the group to collaborate on folders.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC22memberViewabilityLevelAA0c6MembereF0OSgvp":{"name":"memberViewabilityLevel","abstract":"

    Specifies who can view the members of the group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Group"},"Classes/FolderUploadEmail.html#/s:6BoxSDK17FolderUploadEmailC6accessSSSgvp":{"name":"access","abstract":"

    Access level

    ","parent_name":"FolderUploadEmail"},"Classes/FolderUploadEmail.html#/s:6BoxSDK17FolderUploadEmailC5emailSSSgvp":{"name":"email","abstract":"

    Email addresss

    ","parent_name":"FolderUploadEmail"},"Classes/FolderLock/LockedOperations.html#/s:6BoxSDK10FolderLockC16LockedOperationsV6deleteSbSgvp":{"name":"delete","abstract":"

    Whether deleting the folder is restricted.

    ","parent_name":"LockedOperations"},"Classes/FolderLock/LockedOperations.html#/s:6BoxSDK10FolderLockC16LockedOperationsV4moveSbSgvp":{"name":"move","abstract":"

    Whether moving the folder is restricted.

    ","parent_name":"LockedOperations"},"Classes/FolderLock/LockedOperations.html":{"name":"LockedOperations","abstract":"

    Locked operations on the folder

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user or group that created the lock.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the folder lock object was created.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC6folderAA0C0CSgvp":{"name":"folder","abstract":"

    The (mini) folder object that the lock applies to.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC8lockTypeSSSgvp":{"name":"lockType","abstract":"

    The lock type, value is always “freeze”.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC16lockedOperationsAC06LockedF0VSgvp":{"name":"lockedOperations","abstract":"

    The operations that have been locked.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FolderLock"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Download permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canUploadSbSgvp":{"name":"canUpload","abstract":"

    Upload permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Rename permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Delete permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Share permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV21canInviteCollaboratorSbSgvp":{"name":"canInviteCollaborator","abstract":"

    Permission to add collaborators

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Permission to set shared link access level for the folder

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html":{"name":"Permissions","abstract":"

    An object containing the permissions that the current user has on this file.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this folder. Used with If-Match headers.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4nameSSSgvp":{"name":"name","abstract":"

    The name of the folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time the folder was created.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this folder was last updated on the Box servers.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the folder. The limit is 256 characters.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC37isCollaborationRestrictedToEnterpriseSbSgvp":{"name":"isCollaborationRestrictedToEnterprise","abstract":"

    Whether future collaborations should be restricted to within the enterprise only

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4sizeSiSgvp":{"name":"size","abstract":"

    The folder size in bytes.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC14pathCollectionAA04PathE0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this folder, starting at the root.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last modified this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10sharedLinkAA06SharedE0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this file. Is nil if no shared link has been created.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17folderUploadEmailAA0ceF0CSgvp":{"name":"folderUploadEmail","abstract":"

    The upload email address for this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC6parentACSgvp":{"name":"parent","abstract":"

    The folder that contains this folder. May be nil for folders such as root, trash and child folders whose parent is inaccessible.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10itemStatusAA04ItemE0OSgvp":{"name":"itemStatus","abstract":"

    Whether this item is deleted or not.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC16contentCreatedAt10Foundation4DateVSgvp":{"name":"contentCreatedAt","abstract":"

    The time the folder or its contents were originally created (according to the uploader). May be nil for some folders such as root or trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17contentModifiedAt10Foundation4DateVSgvp":{"name":"contentModifiedAt","abstract":"

    The time the folder or its contents were last modified (according to the uploader). May be nil for some folders such as root or trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC18canNonOwnersInviteSbSgvp":{"name":"canNonOwnersInvite","abstract":"

    Whether non-owners can invite collaborators to this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    The time the folder or its contents were put in the trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    The time the folder or its contents will be purged from the trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9syncStateAA04SyncE0OSgvp":{"name":"syncState","abstract":"

    Whether this folder will be synced by the Box sync clients or not.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17hasCollaborationsSbSgvp":{"name":"hasCollaborations","abstract":"

    Whether this folder has any collaborators.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    An object containing the permissions that the current user has on this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4tagsSaySSGSgvp":{"name":"tags","abstract":"

    All tags applied to this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC29allowedSharedLinkAccessLevelsSayAA0efG0OGSgvp":{"name":"allowedSharedLinkAccessLevels","abstract":"

    Access level settings for shared links set by administrator.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC19allowedInviteeRolesSaySSGSgvp":{"name":"allowedInviteeRoles","abstract":"

    Folder collaboration roles allowed by the enterprise administrator.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17isExternallyOwnedSbSgvp":{"name":"isExternallyOwned","abstract":"

    Whether this folder is owned by a user outside of the enterprise.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11collectionsSaySDyS2SGGSgvp":{"name":"collections","abstract":"

    The collections the folder belongs to

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC14classificationAA14ClassificationCSgvp":{"name":"classification","abstract":"

    Details about the classification applied to a Box folder

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Folder"},"Classes/FileVersionRetention.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC04fileD0AA0cD0CSgvp":{"name":"fileVersion","abstract":"

    The file version this file version retention was applied to.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4fileAA0C0CSgvp":{"name":"file","abstract":"

    The file this file version retention was applied to.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC9appliedAt10Foundation4DateVSgvp":{"name":"appliedAt","abstract":"

    When this file version retention object was created.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC13dispositionAt10Foundation4DateVSgvp":{"name":"dispositionAt","abstract":"

    When the retention period expires on this file version retention.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC07winningE6PolicyAA0eG0CSgvp":{"name":"winningRetentionPolicy","abstract":"

    The winning retention policy applied to this file version retention. A file version can have multiple retention policies applied.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC2idSSvp":{"name":"id","abstract":"

    The ID of the file version legal hold object.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC04fileD0AA0cD0CSgvp":{"name":"fileVersion","abstract":"

    The file version that is held

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4fileAA0C0CSgvp":{"name":"file","abstract":"

    The parent file of the file version that is held.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC05legalF17PolicyAssignmentsSayAA0efH10AssignmentCGSgvp":{"name":"legalHoldPolicyAssignments","abstract":"

    List of assignments contributing to this hold.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    Time that this file version legal hold was deleted.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC2idSSvp":{"name":"id","abstract":"

    The ID of the file version object

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4sha1SSSgvp":{"name":"sha1","abstract":"

    The SHA-1 hash of the file.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4nameSSSgvp":{"name":"name","abstract":"

    The name of the file version

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4sizes5Int64VSgvp":{"name":"size","abstract":"

    Size of the file version in bytes

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC19uploaderDisplayNameSSSgvp":{"name":"uploaderDisplayName","abstract":"

    User’s name at the time of upload

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the file version object was created

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the file version object was last updated

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last updated the file version

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When the file version object was trashed.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9trashedByAA4UserCSgvp":{"name":"trashedBy","abstract":"

    The user who trashed the file version.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When the file version object was purged.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10restoredAt10Foundation4DateVSgvp":{"name":"restoredAt","abstract":"

    When the file version object was restored.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10restoredByAA4UserCSgvp":{"name":"restoredBy","abstract":"

    The user who restored the file version.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersion"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Permission for download

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV10canPreviewSbSgvp":{"name":"canPreview","abstract":"

    Permission for preview

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canUploadSbSgvp":{"name":"canUpload","abstract":"

    Permission for upload

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV10canCommentSbSgvp":{"name":"canComment","abstract":"

    Permission to comment

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Permission to rename

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Permission to delete

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Permission to share

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Permission to share access

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV21canInviteCollaboratorSbSgvp":{"name":"canInviteCollaborator","abstract":"

    Permission to invite collaborators

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV11canAnnotateSbSgvp":{"name":"canAnnotate","abstract":"

    Permission to annotate

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV21canViewAnnotationsAllSbSgvp":{"name":"canViewAnnotationsAll","abstract":"

    Permission to view all annotations

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV22canViewAnnotationsSelfSbSgvp":{"name":"canViewAnnotationsSelf","abstract":"

    Permission to view signed in user annotations

    ","parent_name":"Permissions"},"Classes/File/Permissions.html":{"name":"Permissions","abstract":"

    Permissions that the current user has on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11fileVersionAA0cE0CSgvp":{"name":"fileVersion","abstract":"

    The version information of the file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this file object.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4sha1SSSgvp":{"name":"sha1","abstract":"

    The SHA-1 hash of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4nameSSSgvp":{"name":"name","abstract":"

    The name of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9extensionSSSgvp":{"name":"extension","abstract":"

    Indicates the suffix, when available, on the file. By default, set to an empty string.","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11descriptionSSSgvp":{"name":"description","abstract":"

    The description of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4sizeSiSgvp":{"name":"size","abstract":"

    Size of this file in bytes.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC14pathCollectionAA04PathE0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this item, starting at the root.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC12commentCountSiSgvp":{"name":"commentCount","abstract":"

    Description

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The number of comments on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this file was last updated on the Box servers.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When this file was moved to the trash.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When this file will be permanently deleted.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC16contentCreatedAt10Foundation4DateVSgvp":{"name":"contentCreatedAt","abstract":"

    When the content of this file was created.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17contentModifiedAt10Foundation4DateVSgvp":{"name":"contentModifiedAt","abstract":"

    When the content of this file was last modified.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9isPackageSbSgvp":{"name":"isPackage","abstract":"

    Whether the file is a package. Used for Mac Packages used by iWorks.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC19uploaderDisplayNameSSSgvp":{"name":"uploaderDisplayName","abstract":"

    User’s name at the time of upload

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who first created this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last updated this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10sharedLinkAA06SharedE0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    The folder containing this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10itemStatusAA04ItemE0OSgvp":{"name":"itemStatus","abstract":"

    Whether this item is deleted or not. Values include active, trashed if the file has been moved to the trash,","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC13versionNumberSSSgvp":{"name":"versionNumber","abstract":"

    The version number of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When the file will automatically be deleted, i.e. expired.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Permissions that the current user has on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17expiringEmbedLinkAA08ExpiringeF0CSgvp":{"name":"expiringEmbedLink","abstract":"

    An expiring URL for an embedded preview session in an iframe. This URL will expire after 60 seconds and the session will expire after 60 minutes.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11collectionsSaySDyS2SGGSgvp":{"name":"collections","abstract":"

    The collections that the file belongs to

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4lockAA4LockCSgvp":{"name":"lock","abstract":"

    The lock held on this file. If there is no lock, this can either be null or have a timestamp in the past.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4tagsSaySSGSgvp":{"name":"tags","abstract":"

    All tags applied to this file

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17hasCollaborationsSbSgvp":{"name":"hasCollaborations","abstract":"

    Whether this file has any collaborators.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17isExternallyOwnedSbSgvp":{"name":"isExternallyOwned","abstract":"

    Whether this file is owned by a user outside of the enterprise.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC19allowedInviteeRolesSayAA17CollaborationRoleOGSgvp":{"name":"allowedInviteeRoles","abstract":"

    File collaboration roles allowed by the enterprise administrator.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC15representationsAA24EntryContainerInnerModelCyAA0C14RepresentationVGSgvp":{"name":"representations","abstract":"

    Digital assets created for this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC14classificationAA14ClassificationCSgvp":{"name":"classification","abstract":"

    Details about the classification applied to a Box file

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"File"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    Embed link URL

    ","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC5tokenAA5TokenCSgvp":{"name":"token","abstract":"

    Information about the token used by the embed component

    ","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ExpiringEmbedLink"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO7commentyAeA7CommentCcAEmF":{"name":"comment(_:)","abstract":"

    Comment type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO7unknownyA2EmF":{"name":"unknown","abstract":"

    Unknown type

    ","parent_name":"EventItemType"},"Classes/EventItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EventItem"},"Classes/EventItem/EventItemType.html":{"name":"EventItemType","abstract":"

    Type of the object modified by the event

    ","parent_name":"EventItem"},"Classes/EventItem.html#/s:6BoxSDK9EventItemC9itemValueAC0cD4TypeOvp":{"name":"itemValue","abstract":"

    Event item type

    ","parent_name":"EventItem"},"Classes/EventItem.html#/s:6BoxSDK9EventItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EventItem"},"Classes/EventContainer.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of events

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC7entriesSayAA0C0CGSgvp":{"name":"entries","abstract":"

    Events in a container

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC5limitSiSgvp":{"name":"limit","abstract":"

    Maximum number of events per page

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC18nextStreamPositionSSSgvp":{"name":"nextStreamPosition","abstract":"

    Defines next stream position in the stream

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC9chunkSizeSiSgvp":{"name":"chunkSize","abstract":"

    The number of event records contained in the object with entries.

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EventContainer"},"Classes/Event.html#/s:6BoxSDK5EventC4typeSSvp":{"name":"type","abstract":"

    Box event object type

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user that performed the action represented by the event. Some events may be performed by users not logged into Box.","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9eventTypeAA0cE0Ovp":{"name":"eventType","abstract":"

    One of the event types.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9sessionIdSSSgvp":{"name":"sessionId","abstract":"

    The session ID of the user who performed the action represented by the event.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC6sourceAA0C4ItemCSgvp":{"name":"source","abstract":"

    The object associated with the event.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the event occurred (when the user performed the action).

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC10recordedAt10Foundation4DateVSgvp":{"name":"recordedAt","abstract":"

    When the event was stored in the Box database.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC17additionalDetailsSDySSypGSgvp":{"name":"additionalDetails","abstract":"

    Additional details for the event

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Event"},"Classes/EntryContainerInnerModel.html#/s:6BoxSDK24EntryContainerInnerModelC7entriesSayxGSgvp":{"name":"entries","abstract":"

    Container entries

    ","parent_name":"EntryContainerInnerModel"},"Classes/Order.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC2bySSSgvp":{"name":"by","abstract":"

    Defines which parameters are items ordered by

    ","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC9directionAA0C9DirectionOSgvp":{"name":"direction","abstract":"

    Defines direction of items order - ascending or descending

    ","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Order"},"Classes/EntryContainer.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of entries

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC7entriesSayxGvp":{"name":"entries","abstract":"

    Entries in a container

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC6offsetSiSgvp":{"name":"offset","abstract":"

    Paging offset

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC10nextMarkerSSSgvp":{"name":"nextMarker","abstract":"

    Next paging marker value

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC18nextStreamPositionSSSgvp":{"name":"nextStreamPosition","abstract":"

    Next stream position

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC5limitSiSgvp":{"name":"limit","abstract":"

    Maximum number of items per page

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC5orderSayAA5OrderCGSgvp":{"name":"order","abstract":"

    Defines how entries are ordered

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC4jsonACyxGSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EntryContainer"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4typeSSvp":{"name":"type","abstract":"

    Type of Box item.

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4nameSSSgvp":{"name":"name","abstract":"

    Enterprise name

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Enterprise"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC4typeSSvp":{"name":"type","abstract":"

    Type of Box item.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC11isConfirmedSbSgvp":{"name":"isConfirmed","abstract":"

    Whether email alias is confirmed.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC5emailSSSgvp":{"name":"email","abstract":"

    User’s email address.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EmailAlias"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC2idSSvp":{"name":"id","abstract":"

    The ID of the device pinner object.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user that the device pin belongs to.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC11productNameSSSgvp":{"name":"productName","abstract":"

    The type of device being pinned.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time the device pin was created.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time the device pin was modified.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"DevicePin"},"Classes/Comment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC07isReplyC0SbSgvp":{"name":"isReplyComment","abstract":"

    Whether or not this comment is a reply to another comment.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC7messageSSSgvp":{"name":"message","abstract":"

    The comment text that the user typed.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC13taggedMessageSSSgvp":{"name":"taggedMessage","abstract":"

    The string representing the comment text with @mentions included. @mention format is @[id:username]","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    A mini user object representing the author of the comment.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time this comment was created.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The object this comment was placed on.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time this comment was last modified

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Comment"},"Classes/Collaborator/CollaboratorType.html#/s:6BoxSDK12CollaboratorC0C4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"CollaboratorType"},"Classes/Collaborator/CollaboratorType.html#/s:6BoxSDK12CollaboratorC0C4TypeO5groupyAeA5GroupCcAEmF":{"name":"group(_:)","abstract":"

    Group type

    ","parent_name":"CollaboratorType"},"Classes/Collaborator.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Collaborator"},"Classes/Collaborator/CollaboratorType.html":{"name":"CollaboratorType","abstract":"

    Type of collaborator

    ","parent_name":"Collaborator"},"Classes/Collaborator.html#/s:6BoxSDK12CollaboratorC17collaboratorValueAC0C4TypeOvp":{"name":"collaboratorValue","abstract":"

    Type of collaborator

    ","parent_name":"Collaborator"},"Classes/Collaborator.html#/s:6BoxSDK12CollaboratorC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Collaborator"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4userAA4UserCSgvp":{"name":"user","abstract":"

    The user that is exempted from the collaboration allowlist

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the enterprise.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the target object was created.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the target object was last modified.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC6domainSSSgvp":{"name":"domain","abstract":"

    The URL domain name

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC9directionAA0C9DirectionOSgvp":{"name":"direction","abstract":"

    Direction of colaboration - can be inbound, outbound or both

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the user’s enterprise.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the collaboration object was created.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the collaboration object was last modified.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC013enterpriseHasdE11AuthEnabledSbvp":{"name":"enterpriseHasTwoFactorAuthEnabled","abstract":"

    Indicator for whether the enterpise has two factor authentication enabled.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC07userHasdeF7EnabledSbvp":{"name":"userHasTwoFactorAuthenticationEnabled","abstract":"

    Indicator for whether the user has two factor authentication enabled.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC06strongE24RequiredForExternalUsersSbvp":{"name":"strongPasswordRequiredForExternalUsers","abstract":"

    Indicator for whether the current enterprise has strong password enabled for users external","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC07userHasdE0Sbvp":{"name":"userHasStrongPassword","abstract":"

    Indicator for whether the user has strong password enabled.

    ","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC10isAcceptedSbvp":{"name":"isAccepted","abstract":"

    Indicator for whether or not the Terms of Service has been accepted.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC05termseF0AA0deF0Cvp":{"name":"termsOfService","abstract":"

    The Terms of Service associated with the requirement status.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC25termsOfServiceRequirementAC05TermshiJ0Cvp":{"name":"termsOfServiceRequirement","abstract":"

    The requirements for Terms of Service part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC25strongPasswordRequirementAC06StronghI0Cvp":{"name":"strongPasswordRequirement","abstract":"

    The requirements for Strong Password part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC34twoFactorAuthenticationRequirementAC03TwohiJ0Cvp":{"name":"twoFactorAuthenticationRequirement","abstract":"

    The requirements for Two Factor Authentication part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the collaboration object.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the collaboration object was created.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the collaboration object was last modified.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When the collaboration will expire.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC6statusAA0C6StatusOSgvp":{"name":"status","abstract":"

    The status of the collaboration invitation.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC12accessibleByAA12CollaboratorCSgvp":{"name":"accessibleBy","abstract":"

    The user or group that is granted access.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4roleAA0C4RoleOSgvp":{"name":"role","abstract":"

    The level of access granted.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC14acknowledgedAt10Foundation4DateVSgvp":{"name":"acknowledgedAt","abstract":"

    When the status of the collaboration object changed to accepted or rejected.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The file or folder that access is granted to

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC11inviteEmailSSSgvp":{"name":"inviteEmail","abstract":"

    The email address used to invite an un-registered collaborator, if they are not a registered user.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC11canViewPathSbSgvp":{"name":"canViewPath","abstract":"

    Whether the “view path collaboration” feature is enabled or not.","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC28acceptanceRequirementsStatusAC010AcceptanceeF0CSgvp":{"name":"acceptanceRequirementsStatus","abstract":"

    The acceptance requirements for the user or enterprise.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Collaboration"},"Classes/Collaboration/AcceptanceRequirementsStatus.html":{"name":"AcceptanceRequirementsStatus","abstract":"

    Defines the Acceptance Requirements Status object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/TermsOfServiceRequirement.html":{"name":"TermsOfServiceRequirement","abstract":"

    Defines the Terms of Service requirement for the Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/StrongPasswordRequirement.html":{"name":"StrongPasswordRequirement","abstract":"

    Defines the Strong Password requirement for the Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html":{"name":"TwoFactorAuthenticationRequirement","abstract":"

    Defines the Two Factor Authentication Requirement for Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Classification.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC5colorSo7UIColorCSgvp":{"name":"color","abstract":"

    The color that is used to display the classification label in a user-interface

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC10definitionSSSgvp":{"name":"definition","abstract":"

    An explanation of the meaning of this classification

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC4nameSSSgvp":{"name":"name","abstract":"

    Name of the classification

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Classification"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4typeSSvp":{"name":"type","abstract":"

    Box item type - should be collection.

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4nameSSSgvp":{"name":"name","abstract":"

    Name of the collection

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC14collectionTypeSSSgvp":{"name":"collectionType","abstract":"

    The type of the collection. This is used to determine the proper visual treatment for collections.","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxCollection"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO10jsonObjectyAESDySSypGcAEmF":{"name":"jsonObject(_:)","abstract":"

    JSON body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO9jsonArrayyAESaySDySSypGGcAEmF":{"name":"jsonArray(_:)","abstract":"

    JSON Array body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO14urlencodedFormyAESDyS2SGcAEmF":{"name":"urlencodedForm(_:)","abstract":"

    URL encoded form body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO4datayAE10Foundation4DataVcAEmF":{"name":"data(_:)","abstract":"

    Data body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO9multipartyAeA13MultipartFormVcAEmF":{"name":"multipart(_:)","abstract":"

    Multipart form body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO5emptyyA2EmF":{"name":"empty","abstract":"

    Empty body

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html":{"name":"BodyType","abstract":"

    Defines body type of a request

    ","parent_name":"BoxRequest"},"Classes/PagingIterator.html#/s:6BoxSDK14PagingIteratorC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    The total count of the result set, if known

    ","parent_name":"PagingIterator"},"Classes/PagingIterator.html#/s:6BoxSDK14PagingIteratorC4next10completionyys6ResultOyAA14EntryContainerCyxGAA0A8SDKErrorCGc_tF":{"name":"next(completion:)","abstract":"

    Gets next page of elements from the iterator

    ","parent_name":"PagingIterator"},"Classes/BoxNetworkTask.html#/s:6BoxSDK0A11NetworkTaskC9cancelledSbvp":{"name":"cancelled","abstract":"

    Whether the task is cancelled or not

    ","parent_name":"BoxNetworkTask"},"Classes/BoxNetworkTask.html#/s:6BoxSDK0A11NetworkTaskC6cancelyyF":{"name":"cancel()","abstract":"

    Method to cancel a Box Network Task

    ","parent_name":"BoxNetworkTask"},"Classes/BoxNetworkAgent.html#/s:6BoxSDK0A12NetworkAgentC13configurationAcA0A16SDKConfigurationV_tcfc":{"name":"init(configuration:)","abstract":"

    Initializer.

    ","parent_name":"BoxNetworkAgent"},"Classes/BoxNetworkAgent.html#/s:6BoxSDK0A12NetworkAgentC4send7request10completionyAA0A7RequestC_ys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"send(request:completion:)","abstract":"

    Makes Box SDK request

    ","parent_name":"BoxNetworkAgent"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC4list6marker5limit6fieldsAA14PagingIteratorCyAA7WebhookCGSSSg_SiSgSaySSGSgtF":{"name":"list(marker:limit:fields:)","abstract":"

    Get all webhooks in an enterprise.

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC3get9webhookId6fields10completionySS_SaySSGSgys6ResultOyAA7WebhookCAA0A8SDKErrorCGctF":{"name":"get(webhookId:fields:completion:)","abstract":"

    Get information about a webhook.

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6update9webhookId10targetType0hG08triggers7address6fields10completionySS_SSSgALSayAA7WebhookC13EventTriggersOGSgALSaySSGSgys6ResultOyAnA0A8SDKErrorCGctF":{"name":"update(webhookId:targetType:targetId:triggers:address:fields:completion:)","abstract":"

    Update a webhook

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6create10targetType0F2Id8triggers7address6fields10completionySS_SSSayAA7WebhookC13EventTriggersOGSSSaySSGSgys6ResultOyAlA0A8SDKErrorCGctF":{"name":"create(targetType:targetId:triggers:address:fields:completion:)","abstract":"

    Create a webhook

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6delete9webhookId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(webhookId:completion:)","abstract":"

    Deletes a webhook.

    ","parent_name":"WebhooksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC3get9webLinkId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(webLinkId:fields:completion:)","abstract":"

    Get information about a specified web link.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6create3url8parentId4name11description10sharedLink6fields10completionySS_S2SSgAlA17NullableParameterOyAA06SharedM4DataVGSgSaySSGSgys6ResultOyAA0cM0CAA0A8SDKErrorCGctF":{"name":"create(url:parentId:name:description:sharedLink:fields:completion:)","abstract":"

    Creates a new web link with the specified url on the specified item.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6update9webLinkId3url06parentI04name11description06sharedH06fields10completionySS_SSSgA3mA17NullableParameterOyAA06SharedH4DataVGSgSaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"update(webLinkId:url:parentId:name:description:sharedLink:fields:completion:)","abstract":"

    Update the specified web link info.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6delete9webLinkId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(webLinkId:completion:)","abstract":"

    Delete a specified web link.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC13getSharedLink03forcH010completionySS_ys6ResultOyAA0gH0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forWebLink:completion:)","abstract":"

    Gets web link with updated shared link

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC13setSharedLink03forcH06access10unsharedAt8password11canDownload10completionySS_AA0gH6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0gH0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forWebLink:access:unsharedAt:password:canDownload:completion:)","abstract":"

    Creates or updates shared link for a web link

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC16deleteSharedLink03forcH010completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forWebLink:completion:)","abstract":"

    Removes shared link for a web link

    ","parent_name":"WebLinksModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC10getCurrent6fields10completionySaySSGSg_ys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"getCurrent(fields:completion:)","abstract":"

    Get information about the user for which this client is authenticated.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC3get6userId6fields10completionySS_SaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"get(userId:fields:completion:)","abstract":"

    Get information about a user in the enterprise. Requires enterprise administration","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC9getAvatar6userId10completionySS_ys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF":{"name":"getAvatar(userId:completion:)","abstract":"

    Get image of a user’s avatar

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6create5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0J24ExternalCollabRestricted0J22ExemptFromDeviceLimits0J27ExemptFromLoginVerification6status6fields10completionySS_SSAA8UserRoleOSgSSSgSbSgA3Zs5Int64VSgSayAA4UserC12TrackingCodeVGSgA_AZA_A_A_AA10UserStatusOSgSaySSGSgys6ResultOyA4_AA0A8SDKErrorCGctF":{"name":"create(login:name:role:language:isSyncEnabled:jobTitle:phone:address:spaceAmount:trackingCodes:canSeeManagedUsers:timezone:isExternalCollabRestricted:isExemptFromDeviceLimits:isExemptFromLoginVerification:status:fields:completion:)","abstract":"

    Create a new managed user in an enterprise. This method only works for Box admins.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6update6userId5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0L24ExternalCollabRestricted0L22ExemptFromDeviceLimits0L27ExemptFromLoginVerification6status6fields10completionySS_SSSgAxA8UserRoleOSgAXSbSgA3Xs5Int64VSgSayAA4UserC12TrackingCodeVGSgA0_AXA0_A0_A0_AA10UserStatusOSgSaySSGSgys6ResultOyA5_AA0A8SDKErrorCGctF":{"name":"update(userId:login:name:role:language:isSyncEnabled:jobTitle:phone:address:spaceAmount:trackingCodes:canSeeManagedUsers:timezone:isExternalCollabRestricted:isExemptFromDeviceLimits:isExemptFromLoginVerification:status:fields:completion:)","abstract":"

    Update the information for a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC13createAppUser4name8language8jobTitle8timezone5phone7address11spaceAmount6status26isExternalCollabRestricted013canSeeManagedC06fields10completionySS_SSSgA4Qs5Int64VSgAA0G6StatusOSgSbSgAXSaySSGSgys6ResultOyAA0G0CAA0A8SDKErrorCGctF":{"name":"createAppUser(name:language:jobTitle:timezone:phone:address:spaceAmount:status:isExternalCollabRestricted:canSeeManagedUsers:fields:completion:)","abstract":"

    Create a new app user in an enterprise.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6delete6userId6notify5force10completionySS_SbSgAIys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(userId:notify:force:completion:)","abstract":"

    Delete a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC17listForEnterprise10filterTerm6fields9usemarker6marker6offset5limitAA14PagingIteratorCyAA4UserCGSSSg_SaySSGSgSbSgAPSiSgATtF":{"name":"listForEnterprise(filterTerm:fields:usemarker:marker:offset:limit:)","abstract":"

    Returns all of the users for the Enterprise. Only available to admin accounts or service accounts.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC22inviteToJoinEnterprise5login12enterpriseId6fields10completionySS_SSSaySSGSgys6ResultOyAA6InviteCAA0A8SDKErrorCGctF":{"name":"inviteToJoinEnterprise(login:enterpriseId:fields:completion:)","abstract":"

    Invite an existing user to join an Enterprise.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC20moveItemsOwnedByUser6withID02toi4WithK06notify6fields10completionySS_SSSbSgSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"moveItemsOwnedByUser(withID:toUserWithID:notify:fields:completion:)","abstract":"

    Move all of the items owned by a user into a new folder in another user’s account.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC11changeLogin6userId5login6fields10completionySS_SSSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"changeLogin(userId:login:fields:completion:)","abstract":"

    Used to convert one of the user’s confirmed email aliases into the user’s primary login.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16listEmailAliases6userId10completionySS_ys6ResultOyAA14EntryContainerCyAA0F5AliasCGAA0A8SDKErrorCGctF":{"name":"listEmailAliases(userId:completion:)","abstract":"

    Retrieves all email aliases for this user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16createEmailAlias6userId5email10completionySS_SSys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createEmailAlias(userId:email:completion:)","abstract":"

    Adds a new email alias to the given user’s account.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16deleteEmailAlias6userId05emailgI010completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteEmailAlias(userId:emailAliasId:completion:)","abstract":"

    Removes an email alias from a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC19rollOutOfEnterprise6userId6notify6fields10completionySS_SbSgSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"rollOutOfEnterprise(userId:notify:fields:completion:)","abstract":"

    Roll a user out of their enterprise (and convert them to a standalone free user)

    ","parent_name":"UsersModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC9listItems6offset5limit6fieldsAA14PagingIteratorCyAA10FolderItemOGSiSg_AMSaySSGSgtF":{"name":"listItems(offset:limit:fields:)","abstract":"

    Gets the files, folders and web links that are in the user’s trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC7getFile2id6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getFile(id:fields:completion:)","abstract":"

    Get a file that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC9getFolder2id6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getFolder(id:fields:completion:)","abstract":"

    Get a folder that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC10getWebLink2id6fields10completionySS_SaySSGSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getWebLink(id:fields:completion:)","abstract":"

    Get a web link that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC11restoreFile2id4name14parentFolderId6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"restoreFile(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a file that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC13restoreFolder2id4name06parentF2Id6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"restoreFolder(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a folder that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC14restoreWebLink2id4name14parentFolderId6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"restoreWebLink(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a web link that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC21permanentlyDeleteFile2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteFile(id:completion:)","abstract":"

    Permanently delete a file that is in the trash. The file will no longer exist in Box.","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC23permanentlyDeleteFolder2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteFolder(id:completion:)","abstract":"

    Permanently delete a folder that is in the trash. The folder will no longer exist","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC24permanentlyDeleteWebLink2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteWebLink(id:completion:)","abstract":"

    Permanently delete a web link that is in the trash. The web link will no longer exist","parent_name":"TrashModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6create6status7tosType4text6fields10completionyAA0cD13ServiceStatusO_AA0cdnJ0OSSSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF":{"name":"create(status:tosType:text:fields:completion:)","abstract":"

    Creates a Terms of Service for an enterprise.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6update5tosId4text6status6fields10completionySS_SSAA0cD13ServiceStatusOSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF":{"name":"update(tosId:text:status:fields:completion:)","abstract":"

    Updates a specified Terms of Service.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC3get5tosId6fields10completionySS_SaySSGSgys6ResultOyAA0cD7ServiceCAA0A8SDKErrorCGctF":{"name":"get(tosId:fields:completion:)","abstract":"

    Retrieves a specified Terms of Service.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC17listForEnterprise7tosType6fields10completionyAA0cd7ServiceK0OSg_SaySSGSgys6ResultOySayAA0cdN0CGAA0A8SDKErrorCGctF":{"name":"listForEnterprise(tosType:fields:completion:)","abstract":"

    Retrieves both external and managed Terms of Services if no Terms of Service type is specified.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16createUserStatus5tosId10isAccepted04userK06fields10completionySS_SbSSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"createUserStatus(tosId:isAccepted:userId:fields:completion:)","abstract":"

    Creates an association between a terms of service and a specified user. If no user is specified, defaults to current user.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16updateUserStatus04userI2Id10isAccepted6fields10completionySS_SbSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"updateUserStatus(userStatusId:isAccepted:fields:completion:)","abstract":"

    Update the user status on the Terms of Service. Choose to either accept or deny.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC13getUserStatus5tosId04userK06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"getUserStatus(tosId:userId:fields:completion:)","abstract":"

    Retrieves the user status for the specified Terms of Service and the specified user.

    ","parent_name":"TermsOfServicesModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC3get6taskId6fields10completionySS_SaySSGSgys6ResultOyAA4TaskCAA0A8SDKErrorCGctF":{"name":"get(taskId:fields:completion:)","abstract":"

    Fetches a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6create6fileId6action7message5dueAt14completionRule6fields0L0ySS_AA10TaskActionOSSSg10Foundation4DateVSgAA0o10CompletionM0OSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"create(fileId:action:message:dueAt:completionRule:fields:completion:)","abstract":"

    Used to create a single task for single user on a single file.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6update6taskId6action7message5dueAt14completionRule6fields0L0ySS_AA10TaskActionOSSSg10Foundation4DateVSgAA0o10CompletionM0OSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"update(taskId:action:message:dueAt:completionRule:fields:completion:)","abstract":"

    Updates a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6delete6taskId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(taskId:completion:)","abstract":"

    Permanently deletes a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC13getAssignment04taskF2Id6fields10completionySS_SaySSGSgys6ResultOyAA04TaskF0CAA0A8SDKErrorCGctF":{"name":"getAssignment(taskAssignmentId:fields:completion:)","abstract":"

    Fetches a specific task assignment.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6assign6taskId04userG06fields10completionySS_SSSaySSGSgys6ResultOyAA14TaskAssignmentCAA0A8SDKErrorCGctF":{"name":"assign(taskId:userId:fields:completion:)","abstract":"

    Used to assign a task to a single user identified by userId.","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC13assignByEmail6taskId5email6fields10completionySS_SSSaySSGSgys6ResultOyAA14TaskAssignmentCAA0A8SDKErrorCGctF":{"name":"assignByEmail(taskId:email:fields:completion:)","abstract":"

    Used to assign a task to a single user identified by login.","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC16updateAssignment04taskF2Id7message15resolutionState10completionySS_SSSgAA0fK0OSgys6ResultOyAA04TaskF0CAA0A8SDKErrorCGctF":{"name":"updateAssignment(taskAssignmentId:message:resolutionState:completion:)","abstract":"

    Used to update a task assignment.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC16deleteAssignment04taskF2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteAssignment(taskAssignmentId:completion:)","abstract":"

    Permanently deletes a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC15listAssignments9forTaskId10completionySS_ys6ResultOySayAA0H10AssignmentCGAA0A8SDKErrorCGctF":{"name":"listAssignments(forTaskId:completion:)","abstract":"

    Fetches a all task assignments for particular task.

    ","parent_name":"TasksModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC3get15storagePolicyId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(storagePolicyId:fields:completion:)","abstract":"

    Get information about a storage policy.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC17listForEnterprise6marker5limit6fieldsAA14PagingIteratorCyAA0C6PolicyCGSSSg_SiSgSaySSGSgtF":{"name":"listForEnterprise(marker:limit:fields:)","abstract":"

    Get all of the storage policies in an enterprise.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC13getAssignment013storagePolicyG2Id6fields10completionySS_SaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF":{"name":"getAssignment(storagePolicyAssignmentId:fields:completion:)","abstract":"

    Get storage policy assignment information.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC15listAssignments15resolvedForType0hI2Id6fields10completionySS_SSSaySSGSgys6ResultOyAA0C16PolicyAssignmentCAA0A8SDKErrorCGctF":{"name":"listAssignments(resolvedForType:resolvedForId:fields:completion:)","abstract":"

    Get the storage policy assignment assigned to a user or enterprise.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC6assign15storagePolicyId14assignedToType0jkI06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cH10AssignmentCAA0A8SDKErrorCGctF":{"name":"assign(storagePolicyId:assignedToType:assignedToId:fields:completion:)","abstract":"

    Create storage policy assignment.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC11forceAssign15storagePolicyId14assignedToType0klJ06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cI10AssignmentCAA0A8SDKErrorCGctF":{"name":"forceAssign(storagePolicyId:assignedToType:assignedToId:fields:completion:)","abstract":"

    Assign policy

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16updateAssignment013storagePolicyG2Id0hiJ06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF":{"name":"updateAssignment(storagePolicyAssignmentId:storagePolicyId:fields:completion:)","abstract":"

    Update storage policy assignment.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16deleteAssignment013storagePolicyG2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteAssignment(storagePolicyAssignmentId:completion:)","abstract":"

    Deleting a storage policy assignment means the user will inherit the Enterprise’s default storage policy.

    ","parent_name":"StoragePoliciesModule"},"Classes/SharedItemsModule.html#/s:6BoxSDK17SharedItemsModuleC3get13sharedLinkURL0gH8Password6fields10completionySS_SSSgSaySSGSgys6ResultOyAA0C4ItemCAA0A8SDKErrorCGctF":{"name":"get(sharedLinkURL:sharedLinkPassword:fields:completion:)","abstract":"

    Get the item back from the shared link.

    ","parent_name":"SharedItemsModule"},"Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC5queryAD5scope14fileExtensions12createdAfter0I6Before07updatedJ00lK011sizeAtLeast0mN4Most12ownerUserIDs014ancestorFolderS08searchIn8itemType0V5Trash14metadataFilter6fields6offset5limitAA14PagingIteratorCyAA0U4ItemOGSSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA8_A8_A8_s5Int64VSgA11_A4_A4_SayAA0c7ContentY0OGSgAA0c4ItemY0OSgSbSgAA08MetadataC6FilterCSgA4_SiSgA23_tF":{"name":"query(query:scope:fileExtensions:createdAfter:createdBefore:updatedAfter:updatedBefore:sizeAtLeast:sizeAtMost:ownerUserIDs:ancestorFolderIDs:searchIn:itemType:searchTrash:metadataFilter:fields:offset:limit:)","abstract":"

    Searches for items in Box.

    ","parent_name":"SearchModule"},"Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC20queryWithSharedLinks0E05scope14fileExtensions12createdAfter0L6Before07updatedM00oN011sizeAtLeast0pQ4Most12ownerUserIDs014ancestorFolderV08searchIn8itemType0Y5Trash14metadataFilter6fields6offset5limitAA14PagingIteratorCyAA0C6ResultCGSSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA9_A9_A9_s5Int64VSgA12_A5_A5_SayAA0C11ContentTypeOGSgAA0C8ItemTypeOSgSbSgAA08MetadataC6FilterCSgA5_SiSgA24_tF":{"name":"queryWithSharedLinks(query:scope:fileExtensions:createdAfter:createdBefore:updatedAfter:updatedBefore:sizeAtLeast:sizeAtMost:ownerUserIDs:ancestorFolderIDs:searchIn:itemType:searchTrash:metadataFilter:fields:offset:limit:)","abstract":"

    Searches for items in Box, including items that a user might have accessed recently through a shared link.

    ","parent_name":"SearchModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC3get8policyId10completionySS_ys6ResultOyAA0C6PolicyCAA0A8SDKErrorCGctF":{"name":"get(policyId:completion:)","abstract":"

    Retrieves information about a retention policy

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6create4name4type6length17dispositionAction014canOwnerExtendC017areOwnersNotified28customNotificationRecipients10completionySS_AA0C10PolicyTypeOSiSgAA011DispositionK0OSbSgARSayAA4UserCGSgys6ResultOyAA0cV0CAA0A8SDKErrorCGctF":{"name":"create(name:type:length:dispositionAction:canOwnerExtendRetention:areOwnersNotified:customNotificationRecipients:completion:)","abstract":"

    Creates a new retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6update8policyId4name17dispositionAction6status10completionySS_SSSgAA011DispositionK0OSgAA0C12PolicyStatusOSgys6ResultOyAA0cO0CAA0A8SDKErrorCGctF":{"name":"update(policyId:name:dispositionAction:status:completion:)","abstract":"

    Updates existing retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC4list4name4type15createdByUserId6marker5limitAA14PagingIteratorCyAA0C11PolicyEntryCGSSSg_AA0cQ4TypeOSgA2OSiSgtF":{"name":"list(name:type:createdByUserId:marker:limit:)","abstract":"

    Retrieves all of the retention policies for the given enterprise.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC13getAssignment12assignmentId10completionySS_ys6ResultOyAA0c6PolicyG0CAA0A8SDKErrorCGctF":{"name":"getAssignment(assignmentId:completion:)","abstract":"

    Retrieves information about a retention policy assignment.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6assign8policyId015assignedContentH00fJ4Type12filterFields10completionySS_SSAA0c20PolicyAssignmentItemK0OSayAA19MetadataFieldFilterVGSgys6ResultOyAA0coP0CAA0A8SDKErrorCGctF":{"name":"assign(policyId:assignedContentId:assignContentType:filterFields:completion:)","abstract":"

    Creates new retention policy assignment to a content.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC15listAssignments8policyId4type6marker5limitAA14PagingIteratorCyAA0C16PolicyAssignmentCGSS_AA0cO4TypeOSgSSSgSiSgtF":{"name":"listAssignments(policyId:type:marker:limit:)","abstract":"

    Returns a list of all retention policy assignments associated with a specified retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RecentItemsModule.html#/s:6BoxSDK17RecentItemsModuleC4list6marker5limit6fieldsAA14PagingIteratorCyAA0C4ItemCGSSSg_SiSgSaySSGSgtF":{"name":"list(marker:limit:fields:)","abstract":"

    Get recent items.

    ","parent_name":"RecentItemsModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list9forFileId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF":{"name":"list(forFileId:completion:)","abstract":"

    Retrieve all metadata associated with a given file

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"get(forFileWithId:scope:templateKey:completion:)","abstract":"

    Get the metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create13forFileWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"create(forFileWithId:scope:templateKey:keys:completion:)","abstract":"

    Create a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update13forFileWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"update(forFileWithId:scope:templateKey:operations:completion:)","abstract":"

    Update a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(forFileWithId:scope:templateKey:completion:)","abstract":"

    Delete a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list11forFolderId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF":{"name":"list(forFolderId:completion:)","abstract":"

    Retrieve all metadata associated with a given folder

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"get(forFolderWithId:scope:templateKey:completion:)","abstract":"

    Get the metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create15forFolderWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"create(forFolderWithId:scope:templateKey:keys:completion:)","abstract":"

    Create a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update15forFolderWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"update(forFolderWithId:scope:templateKey:operations:completion:)","abstract":"

    Update a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(forFolderWithId:scope:templateKey:completion:)","abstract":"

    Delete a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC16getTemplateByKey5scope08templateH010completionySS_SSys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"getTemplateByKey(scope:templateKey:completion:)","abstract":"

    Get metadata template by name (templateKey).

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC15getTemplateById2id10completionySS_ys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"getTemplateById(id:completion:)","abstract":"

    Get metadata template by ID.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14createTemplate5scope11templateKey11displayName6hidden22copyInstanceOnItemCopy6fields10completionySS_S2SS2bSgSayAA0C5FieldVGys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"createTemplate(scope:templateKey:displayName:hidden:copyInstanceOnItemCopy:fields:completion:)","abstract":"

    Create metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14updateTemplate5scope11templateKey9operation10completionySS_SSAA0cF9OperationOys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"updateTemplate(scope:templateKey:operation:completion:)","abstract":"

    Update metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14deleteTemplate5scope11templateKey10completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteTemplate(scope:templateKey:completion:)","abstract":"

    Delete metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC23listEnterpriseTemplates5scope6marker5limitAA14PagingIteratorCyAA0C8TemplateCGSS_SSSgSiSgtF":{"name":"listEnterpriseTemplates(scope:marker:limit:)","abstract":"

    Retrieve all metadata templates within the specified enterprise

    ","parent_name":"MetadataModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC4list8folderId015ownerEnterpriseI06fields6marker5limitAA14PagingIteratorCyAA0cdE0CGSS_SSSgSaySSGSgAOSiSgtF":{"name":"list(folderId:ownerEnterpriseId:fields:marker:limit:)","abstract":"

    Retrieve an iterator for available metadata cascade policies within a given folder for the current enterprise.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC3get2id6fields10completionySS_SaySSGSgys6ResultOyAA0cdE0CAA0A8SDKErrorCGctF":{"name":"get(id:fields:completion:)","abstract":"

    Get information about a specific metadata cascade policy.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC6create8folderId5scope11templateKey6fields10completionySS_AA0C5ScopeOSSSaySSGSgys6ResultOyAA0cdE0CAA0A8SDKErrorCGctF":{"name":"create(folderId:scope:templateKey:fields:completion:)","abstract":"

    Create a metadata cascade policy that applies to a given folder and a metadata instance attached to the given folder.","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC6delete2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(id:completion:)","abstract":"

    Delete a metadata cascade policy that applies to a given folder and a folder-attached instance of given template.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC10forceApply2id18conflictResolution10completionySS_AA08ConflictK0Oys6ResultOyytAA0A8SDKErrorCGctF":{"name":"forceApply(id:conflictResolution:completion:)","abstract":"

    If a policy already exists on a folder, this will apply that policy to all existing files and sub-folders within the target folder.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC3get8policyId6fields10completionySS_SaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"get(policyId:fields:completion:)","abstract":"

    Get information about a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6create10policyName11description15filterStartedAt0j5EndedL09isOngoing6fields10completionySS_SSSg10Foundation4DateVSgAPSbSgSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"create(policyName:description:filterStartedAt:filterEndedAt:isOngoing:fields:completion:)","abstract":"

    Create a new legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6update8policyId0G4Name11description12releaseNotes6fields10completionySS_SSSgA2KSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"update(policyId:policyName:description:releaseNotes:fields:completion:)","abstract":"

    Update a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6delete8policyId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(policyId:completion:)","abstract":"

    Deletes a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC17listForEnterprise10policyName6marker5limit6fieldsAA14PagingIteratorCyAA0C10HoldPolicyCGSSSg_ANSiSgSaySSGSgtF":{"name":"listForEnterprise(policyName:marker:limit:fields:)","abstract":"

    Get all of the legal hold policies for the enterprise.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC19getPolicyAssignment12assignmentId6fields10completionySS_SaySSGSgys6ResultOyAA0c4HoldgH0CAA0A8SDKErrorCGctF":{"name":"getPolicyAssignment(assignmentId:fields:completion:)","abstract":"

    Get information about a policy assignmnet.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC12assignPolicy8policyId0f2ToI00fJ4Type6fields10completionySS_S2SSaySSGSgys6ResultOyAA0c4HoldG10AssignmentCAA0A8SDKErrorCGctF":{"name":"assignPolicy(policyId:assignToId:assignToType:fields:completion:)","abstract":"

    Assign a legal hold to a file, file version, folder, or user.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC22deletePolicyAssignment12assignmentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deletePolicyAssignment(assignmentId:completion:)","abstract":"

    Sends a request to delete an existing policy assignment.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC21listPolicyAssignments8policyId12assignToType0klJ06marker5limit6fieldsAA14PagingIteratorCyAA0c4HoldG10AssignmentCGSS_SSSgA2PSiSgSaySSGSgtF":{"name":"listPolicyAssignments(policyId:assignToType:assignToId:marker:limit:fields:)","abstract":"

    Get all of the assignments for a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC20getFileVersionPolicy11legalHoldId6fields10completionySS_SaySSGSgys6ResultOyAA0ghcK0CAA0A8SDKErrorCGctF":{"name":"getFileVersionPolicy(legalHoldId:fields:completion:)","abstract":"

    Get information about a file version legal hold.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC23listFileVersionPolicies8policyId6marker5limit6fieldsAA14PagingIteratorCyAA0ghC4HoldCGSS_SSSgSiSgSaySSGSgtF":{"name":"listFileVersionPolicies(policyId:marker:limit:fields:)","abstract":"

    Get all of the non-deleted legal holds for a single legal hold policy

    ","parent_name":"LegalHoldsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC3get7groupId6fields10completionySS_SaySSGSgys6ResultOyAA5GroupCAA0A8SDKErrorCGctF":{"name":"get(groupId:fields:completion:)","abstract":"

    Retrieves a specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6create4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityM06fields10completionySS_SSSgA2mA017GroupInvitabilityM0OSgAA0r6MemberoM0OSgSaySSGSgys6ResultOyAA0R0CAA0A8SDKErrorCGctF":{"name":"create(name:provenance:externalSyncIdentifier:description:invitabilityLevel:memberViewabilityLevel:fields:completion:)","abstract":"

    Creates a new Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6update7groupId4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityO06fields10completionySS_SSSgAA17NullableParameterOySSGSgA2rA017GroupInvitabilityO0OSgAA0v6MemberqO0OSgSaySSGSgys6ResultOyAA0V0CAA0A8SDKErrorCGctF":{"name":"update(groupId:name:provenance:externalSyncIdentifier:description:invitabilityLevel:memberViewabilityLevel:fields:completion:)","abstract":"

    Updates the specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6delete7groupId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(groupId:completion:)","abstract":"

    Deletes the specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17listForEnterprise4name6offset5limit6fieldsAA14PagingIteratorCyAA5GroupCGSSSg_SiSgAOSaySSGSgtF":{"name":"listForEnterprise(name:offset:limit:fields:)","abstract":"

    Get all Groups for an enterprise.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17getMembershipInfo12membershipId6fields10completionySS_SaySSGSgys6ResultOyAA05GroupF0CAA0A8SDKErrorCGctF":{"name":"getMembershipInfo(membershipId:fields:completion:)","abstract":"

    Retrieves a specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16createMembership6userId05groupH04role22configurablePermission6fields10completionySS_SSAA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableL4DataVGSgSaySSGSgys6ResultOyAA0oF0CAA0A8SDKErrorCGctF":{"name":"createMembership(userId:groupId:role:configurablePermission:fields:completion:)","abstract":"

    Creates a Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16updateMembership12membershipId4role22configurablePermission6fields10completionySS_AA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableK4DataVGSgSaySSGSgys6ResultOyAA0nF0CAA0A8SDKErrorCGctF":{"name":"updateMembership(membershipId:role:configurablePermission:fields:completion:)","abstract":"

    Updates the specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16deleteMembership12membershipId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteMembership(membershipId:completion:)","abstract":"

    Deletes the specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC15listMemberships7groupId6offset5limit6fieldsAA14PagingIteratorCyAA15GroupMembershipCGSS_SiSgANSaySSGSgtF":{"name":"listMemberships(groupId:offset:limit:fields:)","abstract":"

    Get all Memberships for a specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC22listMembershipsForUser6userId6offset5limit6fieldsAA14PagingIteratorCyAA15GroupMembershipCGSS_SiSgANSaySSGSgtF":{"name":"listMembershipsForUser(userId:offset:limit:fields:)","abstract":"

    Returns all of the group memberships for a given user. Note this is only available to group admins.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC18listCollaborations7groupId6offset5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SiSgANSaySSGSgtF":{"name":"listCollaborations(groupId:offset:limit:fields:)","abstract":"

    Returns all of the group collaborations for a given group. Note this is only available to group admins.

    ","parent_name":"GroupsModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC3get8folderId6fields10completionySS_SaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"get(folderId:fields:completion:)","abstract":"

    Get information about a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listItems8folderId9usemarker6marker6offset5limit4sort9direction6fieldsAA14PagingIteratorCyAA10FolderItemOGSS_SbSgSSSgSiSgAtA0rF7OrderByOSgAA0T9DirectionOSgSaySSGSgtF":{"name":"listItems(folderId:usemarker:marker:offset:limit:sort:direction:fields:)","abstract":"

    Gets all of the files, folders, or web links contained within a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6create4name8parentId6fields10completionySS_SSSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"create(name:parentId:fields:completion:)","abstract":"

    Create a new folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6update8folderId4name11description06parentG010sharedLink0F17UploadEmailAccess4tags18canNonOwnersInvite37isCollaborationRestrictedToEnterprise11collections6fields10completionySS_SSSgA2qA17NullableParameterOyAA06SharedL4DataVGSgAA06FoldermnO0OSgSaySSGSgSbSgA1_A0_A0_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"update(folderId:name:description:parentId:sharedLink:folderUploadEmailAccess:tags:canNonOwnersInvite:isCollaborationRestrictedToEnterprise:collections:fields:completion:)","abstract":"

    Update a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6delete8folderId9recursive10completionySS_SbSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(folderId:recursive:completion:)","abstract":"

    Delete a folder or move a folder to the trash. The recursive parameter must be included in","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC4copy8folderId19destinationFolderID4name6fields10completionySS_S2SSgSaySSGSgys6ResultOyAA0I0CAA0A8SDKErrorCGctF":{"name":"copy(folderId:destinationFolderID:name:fields:completion:)","abstract":"

    Used to create a copy of a folder in another folder. The original version of the folder will not be altered.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC18listCollaborations8folderId6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SaySSGSgtF":{"name":"listCollaborations(folderId:fields:)","abstract":"

    Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14addToFavorites8folderId10completionySS_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"addToFavorites(folderId:completion:)","abstract":"

    Add folder to favorites

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC15addToCollection8folderId010collectionI010completionySS_SSys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"addToCollection(folderId:collectionId:completion:)","abstract":"

    Add folder to particular collection

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC19removeFromFavorites8folderId10completionySS_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"removeFromFavorites(folderId:completion:)","abstract":"

    Remove folder from favorites

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC20removeFromCollection8folderId010collectionI010completionySS_SSys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"removeFromCollection(folderId:collectionId:completion:)","abstract":"

    Add folder to particular collection

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13getSharedLink9forFolder10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forFolder:completion:)","abstract":"

    Gets folder with updated shared link

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13setSharedLink9forFolder6access10unsharedAt8password11canDownload10completionySS_AA0fG6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forFolder:access:unsharedAt:password:canDownload:completion:)","abstract":"

    Creates or updates shared link for a folder

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC16deleteSharedLink9forFolder10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forFolder:completion:)","abstract":"

    Removes shared link for a folder

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC12getWatermark8folderId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getWatermark(folderId:completion:)","abstract":"

    Retrieves the watermark on a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14applyWatermark8folderId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"applyWatermark(folderId:completion:)","abstract":"

    Apply or update the watermark on a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC15removeWatermark8folderId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"removeWatermark(folderId:completion:)","abstract":"

    Remove the watermark from a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listLocks8folderIdAA14PagingIteratorCyAA10FolderLockCGSS_tF":{"name":"listLocks(folderId:)","abstract":"

    Get all of the locks on a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10createLock8folderId10completionySS_ys6ResultOyAA06FolderF0CAA0A8SDKErrorCGctF":{"name":"createLock(folderId:completion:)","abstract":"

    Creates a folder lock on a folder, preventing it from being moved and/or deleted.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10deleteLock06folderF2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteLock(folderLockId:completion:)","abstract":"

    Remove the specified folder lock.

    ","parent_name":"FoldersModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC3get6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"get(fileId:fields:completion:)","abstract":"

    Get information about a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6update6fileId4name11description06parentG010sharedLink4tags11collections4lock7ifMatch6fields10completionySS_SSSgA2pA17NullableParameterOyAA06SharedL4DataVGSgSaySSGSgAxRyAA04LockW0VGSgApXys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"update(fileId:name:description:parentId:sharedLink:tags:collections:lock:ifMatch:fields:completion:)","abstract":"

    Update the information about a file, including renaming or moving the file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4copy6fileId06parentG04name7version6fields10completionySS_S2SSgAKSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"copy(fileId:parentId:name:version:fields:completion:)","abstract":"

    Create a copy of a file in another folder. The original version of the file will not be","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6upload4data4name8parentId8progress21performPreflightCheck10completionAA0A10UploadTaskC10Foundation4DataV_S2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"upload(data:name:parentId:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13uploadVersion7forFile4name17contentModifiedAt4data7ifMatch8progress21performPreflightCheck10completionAA0A10UploadTaskCSS_SSSgAO10Foundation4DataVAOySo10NSProgressCcSbys6ResultOyAA0H0CAA0A8SDKErrorCGctF":{"name":"uploadVersion(forFile:name:contentModifiedAt:data:ifMatch:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12streamUpload0E08fileSize4name8parentId8progress21performPreflightCheck10completionAA0aF4TaskCSo13NSInputStreamC_SiS2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"streamUpload(stream:fileSize:name:parentId:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19streamUploadVersion0E08fileSize7forFile4name17contentModifiedAt7ifMatch8progress21performPreflightCheck10completionAA0aF4TaskCSo13NSInputStreamC_SiS3SSgARySo10NSProgressCcSbys6ResultOyAA0K0CAA0A8SDKErrorCGctF":{"name":"streamUploadVersion(stream:fileSize:forFile:name:contentModifiedAt:ifMatch:progress:performPreflightCheck:completion:)","abstract":"

    Upload a new version of an existing file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14preflightCheck4name8parentId4size10completionAA0A11NetworkTaskCSS_SSs5Int64VSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"preflightCheck(name:parentId:size:completion:)","abstract":"

    Verifies that new file will be accepted by Box before you send all the bytes over the wire.","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC27preflightCheckForNewVersion7forFile4name4size10completionAA0A11NetworkTaskCSS_SSSgs5Int64VSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"preflightCheckForNewVersion(forFile:name:size:completion:)","abstract":"

    Verifies that an updated file will be accepted by Box before you send all the bytes over the wire. It’s used before","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4lock6fileId9expiresAt19isDownloadPrevented6fields10completionySS_10Foundation4DateVSgSbSgSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"lock(fileId:expiresAt:isDownloadPrevented:fields:completion:)","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6unlock6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"unlock(fileId:fields:completion:)","abstract":"

    Unlock a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getThumbnail7forFile9extension9minHeight0J5Width03maxK00mL010completionySS_AA0F9ExtensionOSiSgA3Nys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF":{"name":"getThumbnail(forFile:extension:minHeight:minWidth:maxHeight:maxWidth:completion:)","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getEmbedLink7forFile10completionySS_ys6ResultOyAA08ExpiringfG0CAA0A8SDKErrorCGctF":{"name":"getEmbedLink(forFile:completion:)","abstract":"

    Get a URL for creating an embedded preview session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC18listCollaborations7forFile6marker5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SSSgSiSgSaySSGSgtF":{"name":"listCollaborations(forFile:marker:limit:fields:)","abstract":"

    Get all of the collaborations on a file (i.e. all of the users that have access to that file).

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listComments7forFile6offset5limit6fieldsAA14PagingIteratorCyAA7CommentCGSS_SiSgANSaySSGSgtF":{"name":"listComments(forFile:offset:limit:fields:)","abstract":"

    Get all of the comments on a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC9listTasks7forFile6fieldsAA14PagingIteratorCyAA4TaskCGSS_SaySSGSgtF":{"name":"listTasks(forFile:fields:)","abstract":"

    Get all of the tasks for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC8download6fileId14destinationURL7version8progress10completionAA0A12DownloadTaskCSS_10Foundation0I0VSSSgySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"download(fileId:destinationURL:version:progress:completion:)","abstract":"

    Download a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6delete6fileId7ifMatch10completionySS_SSSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(fileId:ifMatch:completion:)","abstract":"

    Discards a file to the trash. The etag of the file can be included as an ‘If-Match’ header to prevent race conditions.","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14addToFavorites6fileId10completionySS_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"addToFavorites(fileId:completion:)","abstract":"

    Add file to favorites

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15addToCollection6fileId010collectionI010completionySS_SSys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"addToCollection(fileId:collectionId:completion:)","abstract":"

    Add file to particular collection

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19removeFromFavorites6fileId10completionySS_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"removeFromFavorites(fileId:completion:)","abstract":"

    Remove file from favorites

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC20removeFromCollection6fileId010collectionI010completionySS_SSys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"removeFromCollection(fileId:collectionId:completion:)","abstract":"

    Add file to particular collection

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listVersions6fileId6offset5limit6fieldsAA14PagingIteratorCyAA11FileVersionCGSS_SiSgANSaySSGSgtF":{"name":"listVersions(fileId:offset:limit:fields:)","abstract":"

    Retrieves all file versions on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10getVersion6fileId0gfH06fields10completionySS_SSSaySSGSgys6ResultOyAA04FileF0CAA0A8SDKErrorCGctF":{"name":"getVersion(fileId:fileVersionId:fields:completion:)","abstract":"

    Retrieves a specified file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14promoteVersion6fileId0gfH06fields10completionySS_SSSaySSGSgys6ResultOyAA04FileF0CAA0A8SDKErrorCGctF":{"name":"promoteVersion(fileId:fileVersionId:fields:completion:)","abstract":"

    Promotes the specified file version to the current file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13deleteVersion6fileId0gfH07ifMatch10completionySS_S2SSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteVersion(fileId:fileVersionId:ifMatch:completion:)","abstract":"

    Discards the specified file version to the trash.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getWatermark6fileId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getWatermark(fileId:completion:)","abstract":"

    Retrieves the watermark on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14applyWatermark6fileId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"applyWatermark(fileId:completion:)","abstract":"

    Apply or update the watermark on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15removeWatermark6fileId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"removeWatermark(fileId:completion:)","abstract":"

    Remove the watermark from a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13getSharedLink7forFile10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forFile:completion:)","abstract":"

    Gets file with updated shared link

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13setSharedLink7forFile10unsharedAt6access8password11canDownload10completionySS_AA17NullableParameterOy10Foundation4DateVGSgAA0fG6AccessOSgALySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forFile:unsharedAt:access:password:canDownload:completion:)","abstract":"

    Creates of updates shared link for a file

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16deleteSharedLink7forFile10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forFile:completion:)","abstract":"

    Removes shared link for a file

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11downloadZip4name5items14destinationURL10completionySS_SayAA0F12DownloadItemVG10Foundation0J0Vys6ResultOyAA0fL6StatusCAA0A8SDKErrorCGctF":{"name":"downloadZip(name:items:destinationURL:completion:)","abstract":"

    Creates a zip of multiple files and folders and downloads it.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19createUploadSession8folderId8fileName0J4Size10completionySS_SSs5Int32Vys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createUploadSession(folderId:fileName:fileSize:completion:)","abstract":"

    Create an upload session for uploading a new file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC32createUploadSessionForNewVersion6ofFile8fileName0M4Size10completionySS_SSSgs5Int32Vys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createUploadSessionForNewVersion(ofFile:fileName:fileSize:completion:)","abstract":"

    Create an upload session for uploading a new file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10uploadPart9sessionId4data6offset9totalSize8progress10completionAA0A10UploadTaskCSS_10Foundation4DataVS2iySo10NSProgressCcys6ResultOyAA0oF0CAA0A8SDKErrorCGctF":{"name":"uploadPart(sessionId:data:offset:totalSize:progress:completion:)","abstract":"

    Upload a part of the file to this session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC22listUploadSessionParts9sessionId6offset5limitAA14PagingIteratorCyAA0F15PartDescriptionVGSS_SiSgAMtF":{"name":"listUploadSessionParts(sessionId:offset:limit:)","abstract":"

    Get list of parts of chunked upload session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12commitUpload9sessionId5parts4sha111description10sharedLink4tags11collections4lock16contentCreatedAt0q8ModifiedS010completionySS_SayAA0F15PartDescriptionVGS2SSgAA06SharedM4DataVSgSaySSGSgAxA04LockY0VSg10Foundation4DateVSgA3_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"commitUpload(sessionId:parts:sha1:description:sharedLink:tags:collections:lock:contentCreatedAt:contentModifiedAt:completion:)","abstract":"

    Commit upload session after successful upload of all parts.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11abortUpload9sessionId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"abortUpload(sessionId:completion:)","abstract":"

    Abort chunked upload session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16getUploadSession9sessionId10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getUploadSession(sessionId:completion:)","abstract":"

    Get chunked upload session with ID.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19listRepresentations6fileId18representationHint10completionySS_AA018FileRepresentationJ0OSgys6ResultOySayAA0lM0VGAA0A8SDKErrorCGctF":{"name":"listRepresentations(fileId:representationHint:completion:)","abstract":"

    Get representations for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC24getRepresentationContent6fileId18representationHint9assetPath14destinationURL8progress10completionySS_AA04FilefK0OSS10Foundation0O0VySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"getRepresentationContent(fileId:representationHint:assetPath:destinationURL:progress:completion:)","abstract":"

    Get particular representation for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC22downloadRepresentation9sourceURL011destinationH08progress10completionAA0A12DownloadTaskC10Foundation0H0V_AMySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"downloadRepresentation(sourceURL:destinationURL:progress:completion:)","abstract":"

    Download a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19getVersionRetention11retentionId10completionySS_ys6ResultOyAA04FilefG0CAA0A8SDKErrorCGctF":{"name":"getVersionRetention(retentionId:completion:)","abstract":"

    Retrieves information about a file version retention policy.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC21listVersionRetentions6fileId0hfI006policyI017dispositionAction0K6Before0K5After5limit6markerAA14PagingIteratorCyAA04FileF9RetentionCGSSSg_A2rA011DispositionL0OSg10Foundation4DateVSgAYSiSgARtF":{"name":"listVersionRetentions(fileId:fileVersionId:policyId:dispositionAction:dispositionBefore:dispositionAfter:limit:marker:)","abstract":"

    Retrieves all file version retentions for the given enterprise.

    ","parent_name":"FilesModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC07getUserC010streamType0G8Position5limitAA14PagingIteratorCyAA5EventCGAA06StreamH0OSg_AA0nI0OSgSiSgtF":{"name":"getUserEvents(streamType:streamPosition:limit:)","abstract":"

    Gets events for the current user associated with the access token.","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC013getEnterpriseC010eventTypes12createdAfter0I6Before14streamPosition5limitAA14PagingIteratorCyAA5EventCGSayAA0Q4TypeOGSg_10Foundation4DateVSgAvA06StreamM0OSgSiSgtF":{"name":"getEnterpriseEvents(eventTypes:createdAfter:createdBefore:streamPosition:limit:)","abstract":"

    Gets events for all users and content in the enterprise. Enterprise events are accessible for one year via the API,","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC13getPollingURL10completionyys6ResultOyAA0F7URLInfoCAA0A8SDKErrorCGc_tF":{"name":"getPollingURL(completion:)","abstract":"

    Gets polling URL for checking new changes in an event stream. Works only for user events.

    ","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC013observeForNewC04with10completionyAA14PollingURLInfoC_ys6ResultOyAA0jL0CAA0A8SDKErrorCGctF":{"name":"observeForNewEvents(with:completion:)","abstract":"

    Makes long-polling request for new changes. Server does not return response immediatelly. It only returns response when either","parent_name":"EventsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC3get11devicePinId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(devicePinId:fields:completion:)","abstract":"

    Retrieves a specified Device Pin.

    ","parent_name":"DevicePinsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC17listForEnterprise12enterpriseId6marker5limit9direction6fieldsAA14PagingIteratorCyAA0C3PinCGSS_SSSgSiSgAA14OrderDirectionOSgSaySSGSgtF":{"name":"listForEnterprise(enterpriseId:marker:limit:direction:fields:)","abstract":"

    Retrieves all Device Pins for an enterprise.

    ","parent_name":"DevicePinsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC6delete11devicePinId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(devicePinId:completion:)","abstract":"

    Deletes the specified Device Pin.

    ","parent_name":"DevicePinsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC3get9commentId6fields10completionySS_SaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"get(commentId:fields:completion:)","abstract":"

    Get information about a comment.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6update9commentId7message6fields10completionySS_SSSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"update(commentId:message:fields:completion:)","abstract":"

    Updates the message for a comment.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6create6itemId0F4Type7message6fields10completionySS_S2SSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"create(itemId:itemType:message:fields:completion:)","abstract":"

    Creates a comment on an item.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6delete9commentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(commentId:completion:)","abstract":"

    Deletes the comment.

    ","parent_name":"CommentsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC4list6offset5limit6fieldsAA14PagingIteratorCyAA0A10CollectionCGSiSg_AMSaySSGSgtF":{"name":"list(offset:limit:fields:)","abstract":"

    Retrieves the collections for the given user.

    ","parent_name":"CollectionsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC12getFavorites6fields10completionySaySSGSg_ys6ResultOyAA0A10CollectionCAA0A8SDKErrorCGctF":{"name":"getFavorites(fields:completion:)","abstract":"

    Retrieve the favorites collection

    ","parent_name":"CollectionsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC9listItems12collectionId6offset5limit6fieldsAA14PagingIteratorCyAA10FolderItemOGSS_SiSgANSaySSGSgtF":{"name":"listItems(collectionId:offset:limit:fields:)","abstract":"

    Gets all of the files, folders, or web links contained within a collection.

    ","parent_name":"CollectionsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC3get15collaborationId6fields10completionySS_SaySSGSgys6ResultOyAA13CollaborationCAA0A8SDKErrorCGctF":{"name":"get(collaborationId:fields:completion:)","abstract":"

    Get information about a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6create8itemType0F2Id4role12accessibleBy0jkG011canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSAA010AccessibleK0OSbSgSaySSGSgARys6ResultOyAA0R0CAA0A8SDKErrorCGctF":{"name":"create(itemType:itemId:role:accessibleBy:accessibleByType:canViewPath:fields:notify:completion:)","abstract":"

    Create a new collaboration that grants a group access to a file or folder in a specific role.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC17createByUserEmail8itemType0I2Id4role5login11canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSSbSgSaySSGSgAOys6ResultOyAA0T0CAA0A8SDKErrorCGctF":{"name":"createByUserEmail(itemType:itemId:role:login:canViewPath:fields:notify:completion:)","abstract":"

    Create a new collaboration that grants a user to a file or folder in a specific role.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6update15collaborationId4role6status11canViewPath6fields10completionySS_AA17CollaborationRoleOAA0O6StatusOSgSbSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"update(collaborationId:role:status:canViewPath:fields:completion:)","abstract":"

    Update a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6delete15collaborationId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(collaborationId:completion:)","abstract":"

    Delete a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC24listPendingForEnterprise6offset5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSiSg_AMSaySSGSgtF":{"name":"listPendingForEnterprise(offset:limit:fields:)","abstract":"

    Get information about a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC31getAcceptanceRequirementsStatus15collaborationId10completionySS_ys6ResultOyAA13CollaborationC0fgH0CAA0A8SDKErrorCGctF":{"name":"getAcceptanceRequirementsStatus(collaborationId:completion:)","abstract":"

    Retrieves the acceptance requirements status for a specified collaboration

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC11listEntries6fields6marker5limitAA14PagingIteratorCyAA0cD5EntryCGSaySSGSg_SSSgSiSgtF":{"name":"listEntries(fields:marker:limit:)","abstract":"

    Returns the list of Allowlist entries for the current Enterprise. Each entry lists type, id,","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC3get2id6fields10completionySS_SaySSGSgys6ResultOyAA0cD5EntryCAA0A8SDKErrorCGctF":{"name":"get(id:fields:completion:)","abstract":"

    Get Collaboration Allowlist Entry by ID.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC6create6domain9direction6fields10completionySS_AA0C9DirectionOSaySSGSgys6ResultOyAA0cD5EntryCAA0A8SDKErrorCGctF":{"name":"create(domain:direction:fields:completion:)","abstract":"

    Create Collaboration Allowlist Entry.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC6delete2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(id:completion:)","abstract":"

    Remove a single item from the Enterprise’s Collaboration Allowlist by id.","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC17listExemptTargets6marker5limit6fieldsAA14PagingIteratorCyAA0cdG6TargetCGSSSg_SiSgSaySSGSgtF":{"name":"listExemptTargets(marker:limit:fields:)","abstract":"

    Returns an interator for listing of Exempt User entries for the current Enterprise.","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC15getExemptTarget2id6fields10completionySS_SaySSGSgys6ResultOyAA0cdgH0CAA0A8SDKErrorCGctF":{"name":"getExemptTarget(id:fields:completion:)","abstract":"

    Returns a specific exempt target for the passed in ID.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC10exemptUser6userId6fields10completionySS_SaySSGSgys6ResultOyAA0cD12ExemptTargetCAA0A8SDKErrorCGctF":{"name":"exemptUser(userId:fields:completion:)","abstract":"

    Creates the Exempt Target entry.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC18deleteExemptTarget2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteExemptTarget(id:completion:)","abstract":"

    Remove a single user from the exempt target list.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC7refresh0E5Token10completionySS_ys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"refresh(refreshToken:completion:)","abstract":"

    Refresh the given token.

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC8getToken8withCode10completionySS_ys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"getToken(withCode:completion:)","abstract":"

    Exchange an authorization code for an access token

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC11revokeToken5token10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"revokeToken(token:completion:)","abstract":"

    Revokes an access or refresh token, rendering it invalid.

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC14downscopeToken06parentF05scope8resource10sharedLink10completionySS_ShyAA0F5ScopeOGSSSgAMys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(parentToken:scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"AuthModule"},"Classes/FileLogDestination.html#/s:6BoxSDK18FileLogDestinationC7fileURLAC10Foundation0G0V_tcfc":{"name":"init(fileURL:)","abstract":"

    Intializer.

    ","parent_name":"FileLogDestination"},"Classes/FileLogDestination.html#/s:6BoxSDK18FileLogDestinationC5write_5level8category_ys12StaticStringV_AA0D5LevelOAA0D8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message into a file

    ","parent_name":"FileLogDestination"},"Classes/ConsoleLogDestination.html#/s:6BoxSDK21ConsoleLogDestinationC5write_5level8category_ys12StaticStringV_AA0D5LevelOAA0D8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message into the console

    ","parent_name":"ConsoleLogDestination"},"Classes/MetadataSearchFilter.html#/s:6BoxSDK20MetadataSearchFilterCACycfc":{"name":"init()","abstract":"

    Initializer

    ","parent_name":"MetadataSearchFilter"},"Classes/MetadataSearchFilter.html#/s:6BoxSDK20MetadataSearchFilterC03addE011templateKey05fieldH00I5Value5scope8relationySS_S2SAA0C5ScopeOAA0cE5BoundOtF":{"name":"addFilter(templateKey:fieldKey:fieldValue:scope:relation:)","abstract":"

    Adds a new filter object to our list of filter objects.

    ","parent_name":"MetadataSearchFilter"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC9errorTypeSSvp":{"name":"errorType","abstract":"

    Type of error

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC7messageAA0aC4EnumOvp":{"name":"message","abstract":"

    Error message

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC10stackTraceSaySSGvp":{"name":"stackTrace","abstract":"

    Stack trace

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC5errors5Error_pSgvp":{"name":"error","abstract":"

    Error

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC13getDictionarySDySSypGyF":{"name":"getDictionary()","abstract":"

    Get a dictionary representing BoxSDKError

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC11descriptionSSvp":{"name":"description","abstract":"

    Provides error JSON string if found.

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"BoxSDKError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC7requestAA0A18RequestDescriptionVSgvp":{"name":"request","abstract":"

    The components that make up a description of a BoxRequest

    ","parent_name":"BoxAPIError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC8responseAA0A19ResponseDescriptionVSgvp":{"name":"response","abstract":"

    The components that make up a description of a BoxResponse

    ","parent_name":"BoxAPIError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC13getDictionarySDySSypGyF":{"name":"getDictionary()","abstract":"

    Get a dictionary representing BoxAPIError

    ","parent_name":"BoxAPIError"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5filesAA11FilesModuleCvp":{"name":"files","abstract":"

    Provides File management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7foldersAA13FoldersModuleCvp":{"name":"folders","abstract":"

    Provides Folder management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5usersAA11UsersModuleCvp":{"name":"users","abstract":"

    Provides User management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6groupsAA12GroupsModuleCvp":{"name":"groups","abstract":"

    Provides Group management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8commentsAA14CommentsModuleCvp":{"name":"comments","abstract":"

    Provides Comment management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11sharedItemsAA06SharedE6ModuleCvp":{"name":"sharedItems","abstract":"

    Provides SharedItem management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8webLinksAA03WebE6ModuleCvp":{"name":"webLinks","abstract":"

    Web Links management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6searchAA12SearchModuleCvp":{"name":"search","abstract":"

    Provides search functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11collectionsAA17CollectionsModuleCvp":{"name":"collections","abstract":"

    Provides collections functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14collaborationsAA20CollaborationsModuleCvp":{"name":"collaborations","abstract":"

    Provides collaborations functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC22collaborationWhiteListAA28CollaborationAllowlistModuleCvp":{"name":"collaborationWhiteList","abstract":"

    Provides collaborations whitelist functionality (deprecated)

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC22collaborationAllowListAA28CollaborationAllowlistModuleCvp":{"name":"collaborationAllowList","abstract":"

    Provides collaborations whitelist functionality

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8metadataAA14MetadataModuleCvp":{"name":"metadata","abstract":"

    Metadata management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6eventsAA12EventsModuleCvp":{"name":"events","abstract":"

    Provides Events management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC21metadataCascadePolicyAA08MetadataeF6ModuleCvp":{"name":"metadataCascadePolicy","abstract":"

    Metadata cascade policy.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5trashAA11TrashModuleCvp":{"name":"trash","abstract":"

    Trash management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC10devicePinsAA06DeviceE6ModuleCvp":{"name":"devicePins","abstract":"

    Device Pin management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11recentItemsAA06RecentE6ModuleCvp":{"name":"recentItems","abstract":"

    Recent Items management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8webhooksAA14WebhooksModuleCvp":{"name":"webhooks","abstract":"

    Webhooks management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5tasksAA11TasksModuleCvp":{"name":"tasks","abstract":"

    Tasks management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC15retentionPolicyAA23RetentionPoliciesModuleCvp":{"name":"retentionPolicy","abstract":"

    Retention policy management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14termsOfServiceAA05TermsE14ServicesModuleCvp":{"name":"termsOfService","abstract":"

    Provides TermsOfService

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC10legalHoldsAA05LegalE6ModuleCvp":{"name":"legalHolds","abstract":"

    Legal Hold Policies management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC15storagePoliciesAA07StorageE6ModuleCvp":{"name":"storagePolicies","abstract":"

    Storage Policies management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7sessionAA15SessionProtocol_pvp":{"name":"session","abstract":"

    Provides authentication session management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7headersSDyS2SGSgvp":{"name":"headers","abstract":"

    Requests header.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC13configurationAA0A16SDKConfigurationVvp":{"name":"configuration","abstract":"

    SDK request configuration.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11isDestroyedSbvp":{"name":"isDestroyed","abstract":"

    Indicates whether this BoxClient instance has been destroyed

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC21favoritesCollectionIdSSSgvp":{"name":"favoritesCollectionId","abstract":"

    ID of user’s favorites collection.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC12networkAgent7session13configurationAcA07NetworkE8Protocol_p_AA07SessionI0_pAA0A16SDKConfigurationVtcfc":{"name":"init(networkAgent:session:configuration:)","abstract":"

    Initializer

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14withSharedLink3url8passwordAC10Foundation3URLV_SSSgtF":{"name":"withSharedLink(url:password:)","abstract":"

    Creates BoxClient instance based on shared link URL and password.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6asUser6withIdACSS_tF":{"name":"asUser(withId:)","abstract":"

    Creates BoxClient instance based on user identifier.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7destroy10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"destroy(completion:)","abstract":"

    Destroys the client, revoking its access tokens and rendering it inoperable.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC13exchangeToken5scope8resource10sharedLink10completionyShyAA0E5ScopeOG_SSSgALys6ResultOyAA0E4InfoCAA0A8SDKErrorCGctF":{"name":"exchangeToken(scope:resource:sharedLink:completion:)","abstract":"

    Exchange the token.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3get3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"get(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP GET method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC4post3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC4post3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters4data8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAM4DataVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:data:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response - variant for chunked upload.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7options3url11httpHeaders15queryParameters4json10completionAA0A11NetworkTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"options(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP OPTIONS method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6delete3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"delete(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP DELETE method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8download3url0D14DestinationURL11httpHeaders15queryParameters8progress10completionAA0A12DownloadTaskC10Foundation0G0V_AOSDyS2SGSDySSAA25QueryParameterConvertible_pSgGySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"download(url:downloadDestinationURL:httpHeaders:queryParameters:progress:completion:)","abstract":"

    Performs an HTTP GET method call for downloading on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxSDK/Constants.html#/s:6BoxSDKAAC9ConstantsO10rootFolderSSvpZ":{"name":"rootFolder","abstract":"

    Root folder identifier

    ","parent_name":"Constants"},"Classes/BoxSDK/Constants.html#/s:6BoxSDKAAC9ConstantsO11currentUserSSvpZ":{"name":"currentUser","abstract":"

    Current user identifier

    ","parent_name":"Constants"},"Classes/BoxSDK/Constants.html":{"name":"Constants","abstract":"

    Box-specific constants

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC13configurationAA0A16SDKConfigurationVvp":{"name":"configuration","abstract":"

    SDK configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC20defaultConfigurationAA0A16SDKConfigurationVvpZ":{"name":"defaultConfiguration","abstract":"

    Default configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC4authAA10AuthModuleCvp":{"name":"auth","abstract":"

    Auth module providing authorization and token related requests.","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC8clientId0C6Secret11callbackURLABSS_S2SSgtcfc":{"name":"init(clientId:clientSecret:callbackURL:)","abstract":"

    Initializer

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC9getClient5tokenAA0aD0CSS_tFZ":{"name":"getClient(token:)","abstract":"

    Creates BoxClient object based on developer token

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC9getClient5tokenAA0aD0CSS_tF":{"name":"getClient(token:)","abstract":"

    Creates BoxClient with developer token

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC22getDelegatedAuthClient11authClosure8uniqueID9tokenInfo0K5Store10completionyySS_ys6ResultOySS11accessToken_Sd9expiresInts5Error_pGctc_SSAA0qL0CSgAA0qM0_pSgyAJyAA0aF0CAA0A8SDKErrorCGctF":{"name":"getDelegatedAuthClient(authClosure:uniqueID:tokenInfo:tokenStore:completion:)","abstract":"

    Creates BoxClient using JWT token.

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC15getOAuth2Client9tokenInfo0F5Store7context10completionyAA05TokenG0CSg_AA0kH0_pSgSo47ASWebAuthenticationPresentationContextProviding_pys6ResultOyAA0aE0CAA0A8SDKErrorCGctF":{"name":"getOAuth2Client(tokenInfo:tokenStore:context:completion:)","abstract":"

    Creates BoxClient in a completion with OAuth 2.0 type of authentication

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC15getOAuth2Client9tokenInfo0F5Store10completionyAA05TokenG0CSg_AA0jH0_pSgys6ResultOyAA0aE0CAA0A8SDKErrorCGctF":{"name":"getOAuth2Client(tokenInfo:tokenStore:completion:)","abstract":"

    Creates BoxClient in a completion with OAuth 2.0 type of authentication

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC19updateConfiguration10apiBaseURL09uploadApifG016maxRetryAttempts21tokenRefreshThreshold21consoleLogDestination04fileqR019clientAnalyticsInfoy10Foundation0G0VSg_ANSiSgSdSgAA07ConsoleqR0CSgAA04FileqR0CSgAA06ClientuV0VSgtKF":{"name":"updateConfiguration(apiBaseURL:uploadApiBaseURL:maxRetryAttempts:tokenRefreshThreshold:consoleLogDestination:fileLogDestination:clientAnalyticsInfo:)","abstract":"

    Updates current SDK configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC16makeAuthorizeURL5state10Foundation0E0VSSSg_tF":{"name":"makeAuthorizeURL(state:)","abstract":"

    Creates OAuth2 authorization URL you can use in browser to authorize.

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html":{"name":"BoxSDK","abstract":"

    Provides methods for creating BoxSDKClient

    "},"Classes/BoxClient.html":{"name":"BoxClient","abstract":"

    Provides communication with Box APIs. Defines methods for communication with Box APIs

    "},"Classes.html#/s:6BoxSDK0A12APIAuthErrorC":{"name":"BoxAPIAuthError","abstract":"

    Describes authentication errors.

    "},"Classes/BoxAPIError.html":{"name":"BoxAPIError","abstract":"

    Describes API request related errors.

    "},"Classes.html#/s:6BoxSDK0A11CodingErrorC":{"name":"BoxCodingError","abstract":"

    Describes encoding and decoding related errors.

    "},"Classes.html#/s:6BoxSDK0A12NetworkErrorC":{"name":"BoxNetworkError","abstract":"

    Describes network related errors.

    "},"Classes/BoxSDKError.html":{"name":"BoxSDKError","abstract":"

    Describes general SDK errors

    "},"Classes/MetadataSearchFilter.html":{"name":"MetadataSearchFilter","abstract":"

    Provides functionality for creating a Metadata Search Filter.

    "},"Classes/ConsoleLogDestination.html":{"name":"ConsoleLogDestination","abstract":"

    Defines logging into a console

    "},"Classes/FileLogDestination.html":{"name":"FileLogDestination","abstract":"

    Defines logging into a file

    "},"Classes/AuthModule.html":{"name":"AuthModule","abstract":"

    Provides Token management.

    "},"Classes/CollaborationAllowlistModule.html":{"name":"CollaborationAllowlistModule","abstract":"

    Provides Collaborations management.

    "},"Classes/CollaborationsModule.html":{"name":"CollaborationsModule","abstract":"

    Provides Collaborations management.

    "},"Classes/CollectionsModule.html":{"name":"CollectionsModule","abstract":"

    Management of collections of files and folders. The only collection available is the “Favorites”.

    "},"Classes/CommentsModule.html":{"name":"CommentsModule","abstract":"

    Provides Comment management

    "},"Classes/DevicePinsModule.html":{"name":"DevicePinsModule","abstract":"

    Provides DevicePin management.

    "},"Classes/EventsModule.html":{"name":"EventsModule","abstract":"

    Provides Event management.

    "},"Classes/FilesModule.html":{"name":"FilesModule","abstract":"

    Provides File management.

    "},"Classes/FoldersModule.html":{"name":"FoldersModule","abstract":"

    Provides Folder management.

    "},"Classes/GroupsModule.html":{"name":"GroupsModule","abstract":"

    Provides Group management

    "},"Classes/LegalHoldsModule.html":{"name":"LegalHoldsModule","abstract":"

    Provides management of Legal Holds

    "},"Classes/MetadataCascadePolicyModule.html":{"name":"MetadataCascadePolicyModule","abstract":"

    Defines methods for metadata management

    "},"Classes/MetadataModule.html":{"name":"MetadataModule","abstract":"

    Defines methods for metadata management

    "},"Classes/RecentItemsModule.html":{"name":"RecentItemsModule","abstract":"

    Returns information about files that have been accessed by a user not long ago.

    "},"Classes/RetentionPoliciesModule.html":{"name":"RetentionPoliciesModule","abstract":"

    Provides RetentionPolicy management.

    "},"Classes/SearchModule.html":{"name":"SearchModule","abstract":"

    Provides functionality to search for content.

    "},"Classes/SharedItemsModule.html":{"name":"SharedItemsModule","abstract":"

    Provides SharedItem management.

    "},"Classes/StoragePoliciesModule.html":{"name":"StoragePoliciesModule","abstract":"

    Provides management of Storage Policies

    "},"Classes/TasksModule.html":{"name":"TasksModule","abstract":"

    Provides Tasks management

    "},"Classes/TermsOfServicesModule.html":{"name":"TermsOfServicesModule","abstract":"

    Provides TermsOfService management.

    "},"Classes/TrashModule.html":{"name":"TrashModule","abstract":"

    Module for trash management

    "},"Classes/UsersModule.html":{"name":"UsersModule","abstract":"

    Provides User management.

    "},"Classes/WebLinksModule.html":{"name":"WebLinksModule","abstract":"

    Provides Web Link management.

    "},"Classes/WebhooksModule.html":{"name":"WebhooksModule","abstract":"

    Provides management of Webhooks

    "},"Classes.html#/s:6BoxSDK0A12DownloadTaskC":{"name":"BoxDownloadTask","abstract":"

    A Box network task for a download

    "},"Classes/BoxNetworkAgent.html":{"name":"BoxNetworkAgent","abstract":"

    Implementation of networking layer

    "},"Classes/BoxNetworkTask.html":{"name":"BoxNetworkTask","abstract":"

    A Box network task request.

    "},"Classes.html#/s:6BoxSDK0A10UploadTaskC":{"name":"BoxUploadTask","abstract":"

    A Box network task returned for a upload

    "},"Classes/PagingIterator.html":{"name":"PagingIterator","abstract":"

    Provides paged iterator access for a collection of BoxModel’s

    "},"Classes/BoxRequest.html":{"name":"BoxRequest","abstract":"

    Represents Box SDK API request.

    "},"Classes/BoxCollection.html":{"name":"BoxCollection","abstract":"

    Collections contain information about the items contained inside of them, including files and folders."},"Classes/Classification.html":{"name":"Classification","abstract":"

    Details about the classification applied to a Box file or folder

    "},"Classes/Collaboration.html":{"name":"Collaboration","abstract":"

    Defines access permissions for users and groups to files and folders, similar to access control lists."},"Classes/CollaborationAllowlistEntry.html":{"name":"CollaborationAllowlistEntry","abstract":"

    An allowlisted domain in the enterprise. This record consists of both direction"},"Classes/CollaborationAllowlistExemptTarget.html":{"name":"CollaborationAllowlistExemptTarget","abstract":"

    The record that represents a target (at the moment, only users are supported as targets)"},"Classes/Collaborator.html":{"name":"Collaborator","abstract":"

    User taking part in a collaboration.

    "},"Classes/Comment.html":{"name":"Comment","abstract":"

    Message generated by Box users. Each message is tied to a specific file."},"Classes/DevicePin.html":{"name":"DevicePin","abstract":"

    Defines a device pin which allows the enterprise to control devices connecting to it.

    "},"Classes/EmailAlias.html":{"name":"EmailAlias","abstract":"

    User’s email alias.

    "},"Classes/Enterprise.html":{"name":"Enterprise","abstract":"

    Enterprise

    "},"Classes/EntryContainer.html":{"name":"EntryContainer","abstract":"

    Container for an entries (Box items)

    "},"Classes/Order.html":{"name":"Order","abstract":"

    Defines the order of items

    "},"Classes/EntryContainerInnerModel.html":{"name":"EntryContainerInnerModel","abstract":"

    Entry container for items of inner model

    "},"Classes/Event.html":{"name":"Event","abstract":"

    An event object associated with user or enterprise events.

    "},"Classes/EventContainer.html":{"name":"EventContainer","abstract":"

    Container for Events

    "},"Classes/EventItem.html":{"name":"EventItem","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/ExpiringEmbedLink.html":{"name":"ExpiringEmbedLink","abstract":"

    Expiring embed link of a file

    "},"Classes/File.html":{"name":"File","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/FileVersion.html":{"name":"FileVersion","abstract":"

    Specific version of a file.

    "},"Classes/FileVersionLegalHold.html":{"name":"FileVersionLegalHold","abstract":"

    A file version legal hold object represents all holds on a file version

    "},"Classes/FileVersionRetention.html":{"name":"FileVersionRetention","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/Folder.html":{"name":"Folder","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/FolderLock.html":{"name":"FolderLock","abstract":"

    Folder Lock

    "},"Classes/FolderUploadEmail.html":{"name":"FolderUploadEmail","abstract":"

    Defines upload email address for a folder.

    "},"Classes/Group.html":{"name":"Group","abstract":"

    Contain a set of users, and can be used in place of users in some operations, such as collaborations.

    "},"Classes/GroupMembership.html":{"name":"GroupMembership","abstract":"

    Membership of a group

    "},"Classes/Invite.html":{"name":"Invite","abstract":"

    Defines invitation for a user to join enterprise

    "},"Classes/LegalHoldPolicy.html":{"name":"LegalHoldPolicy","abstract":"

    Legal hold policy

    "},"Classes/LegalHoldPolicyAssignment.html":{"name":"LegalHoldPolicyAssignment","abstract":"

    Legal hold policy assignment

    "},"Classes/LegalHoldPolicyAssignmentItem.html":{"name":"LegalHoldPolicyAssignmentItem","abstract":"

    Legal hold policy assignment item

    "},"Classes/Lock.html":{"name":"Lock","abstract":"

    Locks a file to prevent it from being modified

    "},"Classes/MetadataCascadePolicy.html":{"name":"MetadataCascadePolicy","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/MetadataObject.html":{"name":"MetadataObject","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/MetadataTemplate.html":{"name":"MetadataTemplate","abstract":"

    Metadata that belongs to a file or folder is grouped by templates."},"Classes/PathCollection.html":{"name":"PathCollection","abstract":"

    The path of folders to an item, starting at the root.

    "},"Classes/PollingResult.html":{"name":"PollingResult","abstract":"

    An events long polling result.

    "},"Classes/PollingURLInfo.html":{"name":"PollingURLInfo","abstract":"

    Polling URL info for requesting changes in event stream.

    "},"Classes/RecentItem.html":{"name":"RecentItem","abstract":"

    Item recently iteracted with

    "},"Classes/RetentionPolicy.html":{"name":"RetentionPolicy","abstract":"

    A retention policy blocks permanent deletion of content for a specified amount of time.

    "},"Classes/RetentionPolicyAssignment.html":{"name":"RetentionPolicyAssignment","abstract":"

    The retention policy assignment provides a way for admins to apply a retention policy on a per-folder basis,"},"Classes/RetentionPolicyAssignmentItem.html":{"name":"RetentionPolicyAssignmentItem","abstract":"

    The type and id of the content that is under retention.

    "},"Classes/RetentionPolicyEntry.html":{"name":"RetentionPolicyEntry","abstract":"

    Retention policy entry

    "},"Classes/Scope.html":{"name":"Scope","abstract":"

    Permission scope for a token.

    "},"Classes/SearchResult.html":{"name":"SearchResult","abstract":"

    Files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user.

    "},"Classes/SharedItem.html":{"name":"SharedItem","abstract":"

    Item shared by shared link.

    "},"Classes/SharedLink.html":{"name":"SharedLink","abstract":"

    Provides direct, read-only access to files or folder on Box using a URL

    "},"Classes/StoragePolicy.html":{"name":"StoragePolicy","abstract":"

    Storage policy

    "},"Classes/StoragePolicyAssignment.html":{"name":"StoragePolicyAssignment","abstract":"

    Storage policy assignment

    "},"Classes/Task.html":{"name":"Task","abstract":"

    Enables file-centric workflows in Box. User can create tasks on files and assign them to collaborators on Box."},"Classes/TaskAssignment.html":{"name":"TaskAssignment","abstract":"

    Task assignment to a single user. There can be multiple assignments on a given task.

    "},"Classes/TermsOfService.html":{"name":"TermsOfService","abstract":"

    The Terms of Service allows Box Admins to configure a custom ToS indicating to users."},"Classes/TermsOfServiceUserStatus.html":{"name":"TermsOfServiceUserStatus","abstract":"

    Represents a Terms of Service status for a given user.

    "},"Classes/Token.html":{"name":"Token","abstract":"

    Embed link token

    "},"Classes/TokenInfo.html":{"name":"TokenInfo","abstract":"

    Info about the tokens used by the SDK for authentication.

    "},"Classes/TrackingCode.html":{"name":"TrackingCode","abstract":"

    Admin-defined information about a user

    "},"Classes/UploadPart.html":{"name":"UploadPart","abstract":"

    Object representing part of chunked upload.

    "},"Classes/UploadSession.html":{"name":"UploadSession","abstract":"

    Session object for chunked upload.

    "},"Classes/User.html":{"name":"User","abstract":"

    User of the Box application.

    "},"Classes/Watermark.html":{"name":"Watermark","abstract":"

    Watermark object labels folders and files to be protected by watermarks, which will show on file previews."},"Classes/WebLink.html":{"name":"WebLink","abstract":"

    Object that points to URLs. These objects are also known as bookmarks within the Box web application.

    "},"Classes/Webhook.html":{"name":"Webhook","abstract":"

    Defines a Webhook, which enables event triggers to be attached to Box files and folders

    "},"Classes/ZipDownload.html":{"name":"ZipDownload","abstract":"

    Defines a Zip Download

    "},"Classes/ZipDownloadConflict.html":{"name":"ZipDownloadConflict","abstract":"

    Defines a Zip Download Conflict

    "},"Classes/ZipDownloadConflictItem.html":{"name":"ZipDownloadConflictItem","abstract":"

    Defines a Zip Download Conflict Item

    "},"Classes/ZipDownloadStatus.html":{"name":"ZipDownloadStatus","abstract":"

    Status of a Zip download

    "},"Classes/DelegatedAuthSession.html":{"name":"DelegatedAuthSession","abstract":"

    An authorization session using JWT token

    "},"Classes/OAuth2Session.html":{"name":"OAuth2Session","abstract":"

    OAuth 2 Session

    "},"Classes/SingleTokenSession.html":{"name":"SingleTokenSession","abstract":"

    Developer session that only requires a developer token. Session will only work as long as the token is valid.

    "},"Classes/KeychainTokenStore.html":{"name":"KeychainTokenStore","abstract":"

    Token store that uses the Apple keychain

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file +{"Typealiases.html#/s:6BoxSDK8Callbacka":{"name":"Callback","abstract":"

    Closure to return any generic type or an BoxSDKError"},"Typealiases.html#/s:6BoxSDK16TokenInfoClosurea":{"name":"TokenInfoClosure","abstract":"

    Closure returning either standard TokenInfo object or error."},"Typealiases.html#/s:6BoxSDK15QueryParametersa":{"name":"QueryParameters","abstract":"

    Represents API request query parameters.

    "},"Typealiases.html#/s:6BoxSDK0A11HTTPHeadersa":{"name":"BoxHTTPHeaders","abstract":"

    Represents HTTP headers for API requests.

    "},"Typealiases.html#/s:6BoxSDK16AccessTokenTuplea":{"name":"AccessTokenTuple","abstract":"

    Contains access token and its expiration date.

    "},"Typealiases.html#/s:6BoxSDK20DelegatedAuthClosurea":{"name":"DelegatedAuthClosure","abstract":"

    Contains unique ID as an identifier for JWT token provider and completion returning either valid access token information or an error.

    "},"Typealiases.html#/s:6BoxSDK18AccessTokenClosurea":{"name":"AccessTokenClosure","abstract":"

    Closure returning either access token string or error."},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV2idSSvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"ZipDownloadItem"},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV4typeSSvp":{"name":"type","abstract":"

    Box item type - should be file or folder.

    ","parent_name":"ZipDownloadItem"},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV2id4typeACSS_SStcfc":{"name":"init(id:type:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadItem"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV6partIdSSvp":{"name":"partId","abstract":"

    Part Id

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV6offsetSivp":{"name":"offset","abstract":"

    Part offset

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4sizeSivp":{"name":"size","abstract":"

    Part size

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4sha1SSSgvp":{"name":"sha1","abstract":"

    Part SHA hash

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    The upload part description’s raw data

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV18jsonRepresentationSDySSypGyF":{"name":"jsonRepresentation()","abstract":"

    Get the upload part description in JSON

    ","parent_name":"UploadPartDescription"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5fieldSSvp":{"name":"field","abstract":"

    The field to match against.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5valueSSvp":{"name":"value","abstract":"

    The value to match against.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5field5valueACSS_SStcfc":{"name":"init(field:value:)","abstract":"

    Initializer.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV2idSSSgvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV4typeSSSgvp":{"name":"type","abstract":"

    The data type of the field’s value.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV3keySSSgvp":{"name":"key","abstract":"

    A unique identifier for the field. The identifier must be unique within the template to which it belongs.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV11displayNameSSSgvp":{"name":"displayName","abstract":"

    The display name of the field.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the field.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV7optionsSaySDyS2SGGSgvp":{"name":"options","abstract":"

    For type enum, a list of all possible value

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV6hiddenSbSgvp":{"name":"hidden","abstract":"

    Whether this template is hidden in the UI

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV2id4type3key11displayName11description7options6hiddenACSSSg_A4KSaySDyS2SGGSgSbSgtcfc":{"name":"init(id:type:key:displayName:description:options:hidden:)","abstract":"

    Initializer.

    ","parent_name":"MetadataField"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO4noneyA2EmF":{"name":"none","abstract":"

    Generating the representation needs to be manually triggered (see info.url note).

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO7pendingyA2EmF":{"name":"pending","abstract":"

    Content is being generated but is not ready yet.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO8viewableyA2EmF":{"name":"viewable","abstract":"

    Similar to pending, though indicates that enough content is available to be useful.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO7successyA2EmF":{"name":"success","abstract":"

    All of the content is available and complete.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO5erroryA2EmF":{"name":"error","abstract":"

    An error happened and this content is not available.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    A custom value not implemented in this version of SDK.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"StatusEnum"},"Structs/FileRepresentation/Status.html#/s:6BoxSDK18FileRepresentationV6StatusV5stateAC0E4EnumOSgvp":{"name":"state","abstract":"

    State describing the status

    ","parent_name":"Status"},"Structs/FileRepresentation/Info.html#/s:6BoxSDK18FileRepresentationV4InfoV3urlSSSgvp":{"name":"url","abstract":"

    An opaque URL which will return status information about the file.

    ","parent_name":"Info"},"Structs/FileRepresentation/Content.html#/s:6BoxSDK18FileRepresentationV7ContentV11urlTemplateSSSgvp":{"name":"urlTemplate","abstract":"

    An opaque URL template to the content.

    ","parent_name":"Content"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV7contentAC7ContentVSgvp":{"name":"content","abstract":"

    An opaque URL template to the content.

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV4infoAC4InfoVSgvp":{"name":"info","abstract":"

    An opaque URL which will return status information about the file.

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV10propertiesSDyS2SGvp":{"name":"properties","abstract":"

    A set of static properties to distinguish between subtypes of a given representation,","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV6statusAC6StatusVSgvp":{"name":"status","abstract":"

    Status string

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV14representationSSSgvp":{"name":"representation","abstract":"

    Usually the extension of the format, but occasionally a name of a standard (potentially de facto)","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Content.html":{"name":"Content","abstract":"

    Contains an opaque URL template to the content, which follows RFC 6570.","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Info.html":{"name":"Info","abstract":"

    Contains an opaque URL which will return status information about the file.","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Status.html":{"name":"Status","abstract":"

    Defines the current status of the file representation generation

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation/StatusEnum.html":{"name":"StatusEnum","abstract":"

    A string with one of the following values: ‘none’, ‘pending’, ‘viewable’, ‘error’ and ‘success’.

    ","parent_name":"FileRepresentation"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV10statusCodeSiSgvp":{"name":"statusCode","abstract":"

    The HTTP status code of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV7headersSDyS2SGSgvp":{"name":"headers","abstract":"

    The HTTP headers of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV4bodySDySSypGSgvp":{"name":"body","abstract":"

    The body component of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV6methodSSvp":{"name":"method","abstract":"

    The HTTP method for the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV3urlAA0A13URLComponentsVvp":{"name":"url","abstract":"

    The URL the BoxRequest is sent to

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV7headersSDyS2SGvp":{"name":"headers","abstract":"

    The HTTP headers sent in the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV4bodySSSgvp":{"name":"body","abstract":"

    The optional body of the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV6schemeSSSgvp":{"name":"scheme","abstract":"

    URL scheme information

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV4hostSSSgvp":{"name":"host","abstract":"

    URL host information

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV4pathSSSgvp":{"name":"path","abstract":"

    URL path

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV5querySDyS2SGSgvp":{"name":"query","abstract":"

    Optional URL query parameters

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV8fragmentSSSgvp":{"name":"fragment","abstract":"

    Optional page reference / anchor

    ","parent_name":"BoxURLComponents"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV27isDocumentPreparationNeededSbSgvp":{"name":"isDocumentPreparationNeeded","abstract":"

    Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV24areTextSignaturesEnabledSbSgvp":{"name":"areTextSignaturesEnabled","abstract":"

    Disables the usage of signatures generated by typing (text). Default is true.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV12emailSubjectSSSgvp":{"name":"emailSubject","abstract":"

    Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV12emailMessageSSSgvp":{"name":"emailMessage","abstract":"

    Message to include in sign request email. The field is cleaned through sanitization of specific characters.","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV19areRemindersEnabledSbSgvp":{"name":"areRemindersEnabled","abstract":"

    Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV11prefillTagsSayAA0cD10PrefillTagCGSgvp":{"name":"prefillTags","abstract":"

    List of prefill tags.","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV9daysValidSiSgvp":{"name":"daysValid","abstract":"

    Number of days after which this request will automatically expire if not completed.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV10externalIdSSSgvp":{"name":"externalId","abstract":"

    This can be used to reference an ID in an external system that the sign request is related to.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV27isDocumentPreparationNeeded24areTextSignaturesEnabled12emailSubject0O7Message0k9RemindersN011prefillTags9daysValid10externalIdACSbSg_ALSSSgAmLSayAA0cD10PrefillTagCGSgSiSgAMtcfc":{"name":"init(isDocumentPreparationNeeded:areTextSignaturesEnabled:emailSubject:emailMessage:areRemindersEnabled:prefillTags:daysValid:externalId:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV5emailSSvp":{"name":"email","abstract":"

    Email address of the signer

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV4roleAA0cdF4RoleOSgvp":{"name":"role","abstract":"

    Role of the signer

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV10isInPersonSbSgvp":{"name":"isInPerson","abstract":"

    Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV5orderSiSgvp":{"name":"order","abstract":"

    Order of the signer.

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV22embedUrlExternalUserIdSSSgvp":{"name":"embedUrlExternalUserId","abstract":"

    User ID for the signer in an external application responsible for authentication when accessing the embed URL.

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV5email4role10isInPerson5order22embedUrlExternalUserIdACSS_AA0cdF4RoleOSgSbSgSiSgSSSgtcfc":{"name":"init(email:role:isInPerson:order:embedUrlExternalUserId:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateParentFolder.html#/s:6BoxSDK29SignRequestCreateParentFolderV2idSSvp":{"name":"id","abstract":"

    Identifier of the folder

    ","parent_name":"SignRequestCreateParentFolder"},"Structs/SignRequestCreateParentFolder.html#/s:6BoxSDK29SignRequestCreateParentFolderV2idACSS_tcfc":{"name":"init(id:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateParentFolder"},"Structs/SignRequestCreateParentFolder.html#/s:6BoxSDK29SignRequestCreateParentFolderV6folderAcA0G0C_tcfc":{"name":"init(folder:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateParentFolder"},"Structs/SignRequestCreateSourceFile.html#/s:6BoxSDK27SignRequestCreateSourceFileV2idSSvp":{"name":"id","abstract":"

    Identifier of the file

    ","parent_name":"SignRequestCreateSourceFile"},"Structs/SignRequestCreateSourceFile.html#/s:6BoxSDK27SignRequestCreateSourceFileV11fileVersionAA0cdefgI0VSgvp":{"name":"fileVersion","abstract":"

    The version information of the file.

    ","parent_name":"SignRequestCreateSourceFile"},"Structs/SignRequestCreateSourceFile.html#/s:6BoxSDK27SignRequestCreateSourceFileV2id13fileVersionIdACSS_SSSgtcfc":{"name":"init(id:fileVersionId:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateSourceFile"},"Structs/SignRequestCreateSourceFile.html#/s:6BoxSDK27SignRequestCreateSourceFileV4fileAcA0G0C_tcfc":{"name":"init(file:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateSourceFile"},"Structs/SignRequestCreateSourceFileVersion.html#/s:6BoxSDK34SignRequestCreateSourceFileVersionV2idSSvp":{"name":"id","abstract":"

    The ID of the file version object

    ","parent_name":"SignRequestCreateSourceFileVersion"},"Structs/SignRequestCreateSourceFileVersion.html#/s:6BoxSDK34SignRequestCreateSourceFileVersionV2idACSS_tcfc":{"name":"init(id:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateSourceFileVersion"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV6accessAA0cD6AccessOSgvp":{"name":"access","abstract":"

    The access level for the shared link. Can be open (“People with the link”),","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV8passwordAA17NullableParameterOySSGSgvp":{"name":"password","abstract":"

    The password required to access the shared link.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV10unsharedAtAA17NullableParameterOy10Foundation4DateVGSgvp":{"name":"unsharedAt","abstract":"

    The date-time that this link will become disabled.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV11permissionsSDySSSbGSgvp":{"name":"permissions","abstract":"

    Whether the shared link allows downloads and previews.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV6access8password10unsharedAt11canDownloadAcA0cD6AccessOSg_AA17NullableParameterOySSGSgALy10Foundation4DateVGSgSbSgtcfc":{"name":"init(access:password:unsharedAt:canDownload:)","abstract":"

    Initializer.

    ","parent_name":"SharedLinkData"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormVACycfc":{"name":"init()","abstract":"

    Initialize an empty form.

    ","parent_name":"MultipartForm"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormV10appendPart4name8contentsySS_10Foundation4DataVtF":{"name":"appendPart(name:contents:)","abstract":"

    Append a body part to the form.

    ","parent_name":"MultipartForm"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormV14appendFilePart4name8contents6length8fileName8mimeTypeySS_So13NSInputStreamCSiS2StF":{"name":"appendFilePart(name:contents:length:fileName:mimeType:)","abstract":"

    Append a file body part to the form.

    ","parent_name":"MultipartForm"},"Structs/LockData.html#/s:6BoxSDK8LockDataV9expiresAt19isDownloadPreventedAC10Foundation4DateVSg_SbSgtcfc":{"name":"init(expiresAt:isDownloadPrevented:)","abstract":"

    Initializer.

    ","parent_name":"LockData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV13canRunReportsSbSgvp":{"name":"canRunReports","abstract":"

    Whether the user can run reports.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV15canInstantLoginSbSgvp":{"name":"canInstantLogin","abstract":"

    Whether the user can instant login.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV17canCreateAccountsSbSgvp":{"name":"canCreateAccounts","abstract":"

    Whether the user can create other accounts.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV15canEditAccountsSbSgvp":{"name":"canEditAccounts","abstract":"

    Whether the user can edit accounts.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV13canRunReports0F12InstantLogin0F14CreateAccounts0f4EditL0ACSbSg_A3Htcfc":{"name":"init(canRunReports:canInstantLogin:canCreateAccounts:canEditAccounts:)","abstract":"

    Initializer.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ClientAnalyticsInfo.html#/s:6BoxSDK19ClientAnalyticsInfoV7appName0F7VersionACSS_SStcfc":{"name":"init(appName:appVersion:)","abstract":"

    Initializer

    ","parent_name":"ClientAnalyticsInfo"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV8clientIdSSvp":{"name":"clientId","abstract":"

    The client ID of the application requesting authentication. To get the client ID for your application,","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV12clientSecretSSvp":{"name":"clientSecret","abstract":"

    The client secret of the application requesting authentication. To get the client secret for your application,","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV10apiBaseURL10Foundation0F0Vvp":{"name":"apiBaseURL","abstract":"

    Base URL for majority of the requests.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV16uploadApiBaseURL10Foundation0G0Vvp":{"name":"uploadApiBaseURL","abstract":"

    Base URL for file upload requests.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV18oauth2AuthorizeURL10Foundation0F0Vvp":{"name":"oauth2AuthorizeURL","abstract":"

    URL for the OAuth2 authorization page, where users are redirected to enter their credentials

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV16maxRetryAttemptsSivp":{"name":"maxRetryAttempts","abstract":"

    Maximum number of retries for a failed request.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV21tokenRefreshThresholdSdvp":{"name":"tokenRefreshThreshold","abstract":"

    Specifies how long before token expiration date it should be refreshed.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV17retryBaseIntervalSdvp":{"name":"retryBaseInterval","abstract":"

    The base factor used in calculating exponential backoff delay for retries

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV19clientAnalyticsInfoAA06ClienteF0VSgvp":{"name":"clientAnalyticsInfo","abstract":"

    Analytics info that is set to request headers.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV21consoleLogDestinationAA07ConsoleeF0Cvp":{"name":"consoleLogDestination","abstract":"

    Console log destination.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV18fileLogDestinationAA04FileeF0CSgvp":{"name":"fileLogDestination","abstract":"

    File log destination.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV11callbackURLSSvp":{"name":"callbackURL","abstract":"

    An optional custom callback URL string. The URL to which Box redirects the browser when authentication completes.","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html":{"name":"BoxSDKConfiguration","abstract":"

    SDK configuration specifying request related information

    "},"Structs/ClientAnalyticsInfo.html":{"name":"ClientAnalyticsInfo","abstract":"

    Analytics info about the app using the SDK.

    "},"Structs/ConfigurablePermissionData.html":{"name":"ConfigurablePermissionData","abstract":"

    Defines configurable permission data for creating and updating group membership."},"Structs/LockData.html":{"name":"LockData","abstract":"

    Defines a lock on a Box item

    "},"Structs/MultipartForm.html":{"name":"MultipartForm","abstract":"

    Representation of a multipart form request body.

    "},"Structs/SharedLinkData.html":{"name":"SharedLinkData","abstract":"

    Defines shared link data for updating file information."},"Structs/SignRequestCreateSourceFileVersion.html":{"name":"SignRequestCreateSourceFileVersion","abstract":"

    Represents a file version of a file included in a sign request

    "},"Structs/SignRequestCreateSourceFile.html":{"name":"SignRequestCreateSourceFile","abstract":"

    Represents a file to be included in a sign request.

    "},"Structs/SignRequestCreateParentFolder.html":{"name":"SignRequestCreateParentFolder","abstract":"

    Represents a destination folder to place final, signed document and signing log.

    "},"Structs/SignRequestCreateSigner.html":{"name":"SignRequestCreateSigner","abstract":"

    Defines a signer for Create Sign Request",

    "},"Structs/SignRequestCreateParameters.html":{"name":"SignRequestCreateParameters","abstract":"

    Defines a request to creatre a sign request object.

    "},"Structs/BoxURLComponents.html":{"name":"BoxURLComponents","abstract":"

    The components that make up a URL

    "},"Structs/BoxRequestDescription.html":{"name":"BoxRequestDescription","abstract":"

    The components that make up a description of a BoxRequest

    "},"Structs.html#/s:6BoxSDK0A8ResponseV":{"name":"BoxResponse","abstract":"

    Box API request response

    "},"Structs/BoxResponseDescription.html":{"name":"BoxResponseDescription","abstract":"

    The components that make up a description of a BoxResponse

    "},"Structs/FileRepresentation.html":{"name":"FileRepresentation","abstract":"

    Digital assets created for files stored in Box.

    "},"Structs/MetadataField.html":{"name":"MetadataField","abstract":"

    A field in a metadata template.

    "},"Structs/MetadataFieldFilter.html":{"name":"MetadataFieldFilter","abstract":"

    Filter for matching against a metadata field

    "},"Structs/UploadPartDescription.html":{"name":"UploadPartDescription","abstract":"

    Description of uploaded part

    "},"Structs/ZipDownloadItem.html":{"name":"ZipDownloadItem","abstract":"

    Item field for creating a Zip download.

    "},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP4read10completionyys6ResultOyAA0C4InfoCs5Error_pGc_tF":{"name":"read(completion:)","abstract":"

    Retrieves current token information

    ","parent_name":"TokenStore"},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP5write9tokenInfo10completionyAA0cG0C_ys6ResultOyyts5Error_pGctF":{"name":"write(tokenInfo:completion:)","abstract":"

    Sets new token data

    ","parent_name":"TokenStore"},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP5clear10completionyys6ResultOyyts5Error_pGc_tF":{"name":"clear(completion:)","abstract":"

    Removes a token

    ","parent_name":"TokenStore"},"Protocols/ExpiredTokenHandling.html#/s:6BoxSDK20ExpiredTokenHandlingP06handlecD010completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"handleExpiredToken(completion:)","abstract":"

    Handles token expiration.

    ","parent_name":"ExpiredTokenHandling"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","abstract":"

    Gets access token

    ","parent_name":"SessionProtocol"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","abstract":"

    Revokes all the tokens

    ","parent_name":"SessionProtocol"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP14downscopeToken5scope8resource10sharedLink10completionyShyAA0F5ScopeOG_SSSgALys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"SessionProtocol"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    Raw data from the API that populates the model

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonx10Foundation4DataV_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonSSyF":{"name":"json()","abstract":"

    Gets JSON string for a Box model object.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelPAAE12toJSONStringSSyF":{"name":"toJSONString()","abstract":"

    Gets JSON string for a Box model object.

    ","parent_name":"BoxModel"},"Protocols/QueryParameterConvertible.html#/s:6BoxSDK25QueryParameterConvertibleP15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"QueryParameterConvertible"},"Protocols/NetworkAgentProtocol.html#/s:6BoxSDK20NetworkAgentProtocolP4send7request10completionyAA0A7RequestC_ys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"send(request:completion:)","abstract":"

    Makes a Box SDK request

    ","parent_name":"NetworkAgentProtocol"},"Protocols/TokenRefreshing.html#/s:6BoxSDK15TokenRefreshingP7refresh0eC010completionySS_ys6ResultOyAA0C4InfoCAA0A8SDKErrorCGctF":{"name":"refresh(refreshToken:completion:)","abstract":"

    Refreshes a token.

    ","parent_name":"TokenRefreshing"},"Protocols/TokenRefreshing.html#/s:6BoxSDK15TokenRefreshingP03getC08withCode10completionySS_ys6ResultOyAA0C4InfoCAA0A8SDKErrorCGctF":{"name":"getToken(withCode:completion:)","abstract":"

    Exchange an authorization code for an access token

    ","parent_name":"TokenRefreshing"},"Protocols/LogDestination.html#/s:6BoxSDK14LogDestinationP5write_5level8category_ys12StaticStringV_AA0C5LevelOAA0C8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message

    ","parent_name":"LogDestination"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE2eeoiySbx_SStFZ":{"name":"==(_:_:)","abstract":"

    Compare equality between enum and string

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE2eeoiySbSS_xtFZ":{"name":"==(_:_:)","abstract":"

    Compare equality between string and enum

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

    Encode the enum to a JSON string

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

    Initialization using decoder

    ","parent_name":"BoxEnum"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3get3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"get(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP GET method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP4post3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP4post3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters4data8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAM4DataVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:data:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response - variant for chunked upload.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP7options3url11httpHeaders15queryParameters4json10completionAA0A11NetworkTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"options(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP OPTIONS method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP6delete3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"delete(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP DELETE method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html":{"name":"BoxClientProtocol","abstract":"

    Defines methods for communication with Box APIs

    "},"Protocols/BoxEnum.html":{"name":"BoxEnum","abstract":"

    General BoxEnum protocol specifying response model enum behaviour

    "},"Protocols/LogDestination.html":{"name":"LogDestination","abstract":"

    Defines main log destination behaviour

    "},"Protocols/TokenRefreshing.html":{"name":"TokenRefreshing","abstract":"

    Defines methods for Token refreshing.

    "},"Protocols/NetworkAgentProtocol.html":{"name":"NetworkAgentProtocol","abstract":"

    Defines networking layer interface

    "},"Protocols/QueryParameterConvertible.html":{"name":"QueryParameterConvertible","abstract":"

    Defines items convertible to query parameter

    "},"Protocols/BoxModel.html":{"name":"BoxModel","abstract":"

    Defines Box SDK model behavior

    "},"Protocols.html#/s:6BoxSDK0A10InnerModelP":{"name":"BoxInnerModel","abstract":"

    Box inner model

    "},"Protocols/SessionProtocol.html":{"name":"SessionProtocol","abstract":"

    Defines methods for managing session token.

    "},"Protocols/ExpiredTokenHandling.html":{"name":"ExpiredTokenHandling","abstract":"

    Defines handler for expired token.

    "},"Protocols/TokenStore.html":{"name":"TokenStore","abstract":"

    Defines an interface for managing token.

    "},"Extensions/Optional.html#/s:Sq6BoxSDKAA25QueryParameterConvertibleRzlE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Optional"},"Extensions/Array.html#/s:Sa6BoxSDKSyRzlE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Array"},"Extensions/NSString.html#/s:So8NSStringC6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"NSString"},"Extensions/NSNumber.html#/s:So8NSNumberC6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"NSNumber"},"Extensions/Bool.html#/s:Sb6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Bool"},"Extensions/Int.html#/s:Si6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Int"},"Extensions/String.html#/s:SS6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"String"},"Extensions/String.html":{"name":"String"},"Extensions/Int.html":{"name":"Int"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/NSNumber.html":{"name":"NSNumber"},"Extensions/NSString.html":{"name":"NSString"},"Extensions/Array.html":{"name":"Array"},"Extensions/Optional.html":{"name":"Optional"},"Enums/WebhookItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO6folderyAcA6FolderCcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"WebhookItem"},"Enums/TaskItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:6BoxSDK8TaskItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File with task assignment.

    ","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:6BoxSDK8TaskItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"TaskItem"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO9completedyA2CmF":{"name":"completed","abstract":"

    Completed

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO10incompleteyA2CmF":{"name":"incomplete","abstract":"

    Incomplete

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO8approvedyA2CmF":{"name":"approved","abstract":"

    Approved

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Rejected

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not implemented in this version of SDK.

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AssignmentState"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO9completedyA2CmF":{"name":"completed","abstract":"

    Completed

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO10incompleteyA2CmF":{"name":"incomplete","abstract":"

    Incomplete

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO8approvedyA2CmF":{"name":"approved","abstract":"

    Approved

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Rejected

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not implemented in this version of SDK.

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AssignmentStatus"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO6reviewyA2CmF":{"name":"review","abstract":"

    Approval task that can be approved or rejected

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO8completeyA2CmF":{"name":"complete","abstract":"

    General task which can be completed

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom task action

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"TaskAction"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO12allAssigneesyA2CmF":{"name":"allAssignees","abstract":"

    Task is complete when all assignees complete it

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11anyAssigneeyA2CmF":{"name":"anyAssignee","abstract":"

    Task is complete when any assignees complete it

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"TaskCompletionRule"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO9signatureyA2CmF":{"name":"signature","abstract":"

    Signature input.

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO4dateyA2CmF":{"name":"date","abstract":"

    Date input.

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO4textyA2CmF":{"name":"text","abstract":"

    Text input.

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO8checkboxyA2CmF":{"name":"checkbox","abstract":"

    Checkbox input.

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerDecisionType.html#/s:6BoxSDK29SignRequestSignerDecisionTypeO6signedyA2CmF":{"name":"signed","abstract":"

    Signed decision.

    ","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerDecisionType.html#/s:6BoxSDK29SignRequestSignerDecisionTypeO8declinedyA2CmF":{"name":"declined","abstract":"

    Declined decision.

    ","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerDecisionType.html#/s:6BoxSDK29SignRequestSignerDecisionTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom value not implemented in this version of SDK.

    ","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerDecisionType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerDecisionType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK21SignRequestSignerRoleO6signeryA2CmF":{"name":"signer","abstract":"

    Role needed to sign the document.

    ","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK21SignRequestSignerRoleO8approveryA2CmF":{"name":"approver","abstract":"

    Role needed to approve the document.

    ","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK21SignRequestSignerRoleO15finalCopyReaderyA2CmF":{"name":"finalCopyReader","abstract":"

    Role which receives the final signded document and signing log.

    ","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK21SignRequestSignerRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SignRequestSignerRole"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO10convertingyA2CmF":{"name":"converting","abstract":"

    Converting status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO7createdyA2CmF":{"name":"created","abstract":"

    Created status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO4sentyA2CmF":{"name":"sent","abstract":"

    Sent status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO6viewedyA2CmF":{"name":"viewed","abstract":"

    Viewed status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO6signedyA2CmF":{"name":"signed","abstract":"

    Signed status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO9cancelledyA2CmF":{"name":"cancelled","abstract":"

    Cancelled status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO8declinedyA2CmF":{"name":"declined","abstract":"

    Declined status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO15errorConvertingyA2CmF":{"name":"errorConverting","abstract":"

    Error converting status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO12errorSendingyA2CmF":{"name":"errorSending","abstract":"

    Error sending status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO7expiredyA2CmF":{"name":"expired","abstract":"

    Expired status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SignRequestStatus"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO4openyA2CmF":{"name":"open","abstract":"

    Anyone with the link can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO7companyyA2CmF":{"name":"company","abstract":"

    People in your company can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO13collaboratorsyA2CmF":{"name":"collaborators","abstract":"

    People in this folder can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented by the SDK

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SharedLinkAccess"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO14annotationEdityA2CmF":{"name":"annotationEdit","abstract":"

    Allow user to edit annotations (delete).

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO17annotationViewAllyA2CmF":{"name":"annotationViewAll","abstract":"

    Allows user to view all users’ annotations.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO18annotationViewSelfyA2CmF":{"name":"annotationViewSelf","abstract":"

    Allows user to view their own annotations only.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO12baseExploreryA2CmF":{"name":"baseExplorer","abstract":"

    Allows access to content in the folder tree based on user/file/token permissions.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10basePickeryA2CmF":{"name":"basePicker","abstract":"

    Allows access to content in the folder tree based on user/file/token permissions.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11basePreviewyA2CmF":{"name":"basePreview","abstract":"

    Allows the user to preview the file, nothing else.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11baseSidebaryA2CmF":{"name":"baseSidebar","abstract":"

    Allows the user to get basic file info needed for the sidebar.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10baseUploadyA2CmF":{"name":"baseUpload","abstract":"

    Allows upload into the folder specific under “resource” of the Token Exchange request.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemDeleteyA2CmF":{"name":"itemDelete","abstract":"

    Allows file/folders to be deleted.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO12itemDownloadyA2CmF":{"name":"itemDownload","abstract":"

    Allows files/folders contents to be downloaded.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11itemPreviewyA2CmF":{"name":"itemPreview","abstract":"

    Automatically enables preview of the file, upon user click (requires Preview UI Element to be referenced).

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemRenameyA2CmF":{"name":"itemRename","abstract":"

    Allows files/folders to be renamed.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO9itemShareyA2CmF":{"name":"itemShare","abstract":"

    Allows sharing of resource specified under “resource” of the Token Exchange request.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemUploadyA2CmF":{"name":"itemUpload","abstract":"

    Allows upload in the content picker.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom permission that was not yet implemented in this version of SDK.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of token scope

    ","parent_name":"TokenScope"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO6folderyA2CmF":{"name":"folder","abstract":"

    Folder type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    Enterprise type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO16metadataTemplateyA2CmF":{"name":"metadataTemplate","abstract":"

    Metadata template type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this version of SDK.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO6activeyA2CmF":{"name":"active","abstract":"

    Retention policy is active.

    ","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO7retiredyA2CmF":{"name":"retired","abstract":"

    Retention policy is retired. Can be only retired by administrator","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value that was not yet implemented in current SDK version.

    ","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyStatus"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO17permanentlyDeleteyA2CmF":{"name":"permanentlyDelete","abstract":"

    Content retained by the policy to be permanently deleted once the retention policy time period has passed.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO15removeRetentionyA2CmF":{"name":"removeRetention","abstract":"

    Will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy time period has passed.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in the SDK.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"DispositionAction"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO6finiteyA2CmF":{"name":"finite","abstract":"

    A specific amount of time to retain the content is known upfront.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO10indefiniteyA2CmF":{"name":"indefinite","abstract":"

    The amount of time to retain the content is still unknown.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this SDK version.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyType"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO13addEnumOptionyACSS_SDySSypGtcACmF":{"name":"addEnumOption(fieldKey:data:)","abstract":"

    Adds an enum option at the end of the enum option list for the specified field.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO8addFieldyACSDySSypG_tcACmF":{"name":"addField(data:)","abstract":"

    Adds a field at the end of the field list for the template.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO04editD0yACSDySSypG_tcACmF":{"name":"editTemplate(data:)","abstract":"

    Edits any number of the base properties of a template: displayName, hidden.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO18reorderEnumOptionsyACSS_SaySSGtcACmF":{"name":"reorderEnumOptions(fieldKey:enumOptionKeys:)","abstract":"

    Reorders the enum option list to match the requested enum option list.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO13reorderFieldsyACSaySSG_tcACmF":{"name":"reorderFields(fieldKeys:)","abstract":"

    Reorders the field list to match the requested field list

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO9editFieldyACSS_SDySSypGtcACmF":{"name":"editField(fieldKey:data:)","abstract":"

    Edits any number of the base properties of a field: displayName, hidden, description, key.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO14editEnumOptionyACSS_SDySSypGSStcACmF":{"name":"editEnumOption(fieldKey:data:enumOptionKey:)","abstract":"

    Edits the enumOption.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO16removeEnumOptionyACSS_SStcACmF":{"name":"removeEnumOption(fieldKey:enumOptionKey:)","abstract":"

    Removes the specified enum option from the specified enum field.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO11removeFieldyACSS_tcACmF":{"name":"removeField(fieldKey:)","abstract":"

    Removes the specified field from the template

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an option.

    ","parent_name":"MetadataTemplateOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO3addyACSS_SStcACmF":{"name":"add(path:value:)","abstract":"

    Adds new metadata path/value pair

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO7replaceyACSS_SStcACmF":{"name":"replace(path:value:)","abstract":"

    Replaces metadata for path with a new value

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO4testyACSS_SStcACmF":{"name":"test(path:value:)","abstract":"

    Tests expected metadata value for given path

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO6removeyACSS_tcACmF":{"name":"remove(path:)","abstract":"

    Removes metadata for given path

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an operation option.

    ","parent_name":"FolderMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO3addyACSS_SStcACmF":{"name":"add(path:value:)","abstract":"

    Adds new metadata path/value pair

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO7replaceyACSS_SStcACmF":{"name":"replace(path:value:)","abstract":"

    Replaces metadata for path with a new value

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4testyACSS_SStcACmF":{"name":"test(path:value:)","abstract":"

    Tests expected metadata value for given path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO6removeyACSS_tcACmF":{"name":"remove(path:)","abstract":"

    Removes metadata for given path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4moveyACSS_SStcACmF":{"name":"move(from:path:)","abstract":"

    Moves metadata from original path to new path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4copyyACSS_SStcACmF":{"name":"copy(from:path:)","abstract":"

    Copies metadata from original path to new path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an operation option.

    ","parent_name":"FileMetadataOperation"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO6memberyA2CmF":{"name":"member","abstract":"

    Default permission for a user in a Group.

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO5adminyA2CmF":{"name":"admin","abstract":"

    The admin of the Group.

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access that is not yet implemented

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"GroupRole"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO10adminsOnlyyA2CmF":{"name":"adminsOnly","abstract":"

    Main Admin, Coadmins and group’s Group Admin can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO16adminsAndMembersyA2CmF":{"name":"adminsAndMembers","abstract":"

    Admins and group members can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO15allManagedUsersyA2CmF":{"name":"allManagedUsers","abstract":"

    All managed users in the enterprise can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom level that was not yet implemented in this version of SDK.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO11descriptionSSvp":{"name":"description","abstract":"

    String representation of member viewability level

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO10adminsOnlyyA2CmF":{"name":"adminsOnly","abstract":"

    Main Admin, Co-admins, the group’s Group Admin can invite

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO16adminsAndMembersyA2CmF":{"name":"adminsAndMembers","abstract":"

    Admins and group members can invite

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO15allManagedUsersyA2CmF":{"name":"allManagedUsers","abstract":"

    All managed users in the enterprise.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom level that was not yet implemented in this version of SDK.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO11descriptionSSvp":{"name":"description","abstract":"

    String representation of invitability level.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/FolderItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO6folderyAcA0C0CcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO7webLinkyAcA03WebF0CcACmF":{"name":"webLink(_:)","abstract":"

    Weblink type pointing to either a file or folder.

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Item debug description.

    ","parent_name":"FolderItem"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO11descriptionSSvp":{"name":"description","abstract":"

    String representation of sync state.

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO6syncedyA2CmF":{"name":"synced","abstract":"

    Folder will be synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO9notSyncedyA2CmF":{"name":"notSynced","abstract":"

    Folder will not be synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO15partiallySyncedyA2CmF":{"name":"partiallySynced","abstract":"

    Folder is partially synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom sync option, that is not yet implemented in this SDK version.

    ","parent_name":"SyncState"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO3pdfyA2CmF":{"name":"pdf","abstract":"

    The PDF representation

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO9thumbnailyA2CmF":{"name":"thumbnail","abstract":"

    Thumbnail image with resolution 320x320px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO11imageMediumyA2CmF":{"name":"imageMedium","abstract":"

    Image with resolution 1024x1024px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO10imageLargeyA2CmF":{"name":"imageLarge","abstract":"

    Image with resolution 2048x2048px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO13extractedTextyA2CmF":{"name":"extractedText","abstract":"

    Extracted text from original document.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    It is possible to use a custom value. See representations documentation.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"FileRepresentationHint"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemCreatedyA2CmF":{"name":"itemCreated","abstract":"

    A folder or file was created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12itemUploadedyA2CmF":{"name":"itemUploaded","abstract":"

    A folder or file was uploaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14commentCreatedyA2CmF":{"name":"commentCreated","abstract":"

    A comment was created on a folder, file, or other comment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14commentDeletedyA2CmF":{"name":"commentDeleted","abstract":"

    A comment was deleted on folder, file, or other comment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14itemDownloadedyA2CmF":{"name":"itemDownloaded","abstract":"

    A file or folder was downloaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13itemPreviewedyA2CmF":{"name":"itemPreviewed","abstract":"

    A file was previewed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9itemMovedyA2CmF":{"name":"itemMoved","abstract":"

    A file or folder was moved.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemCopiedyA2CmF":{"name":"itemCopied","abstract":"

    A file or folder was copied.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12taskAssignedyA2CmF":{"name":"taskAssigned","abstract":"

    A task was assigned.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11taskCreatedyA2CmF":{"name":"taskCreated","abstract":"

    A task was created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10fileLockedyA2CmF":{"name":"fileLocked","abstract":"

    A file was locked.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12fileUnlockedyA2CmF":{"name":"fileUnlocked","abstract":"

    A file was unlocked. If a locked file is deleted, the source file will be null.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemDeletedyA2CmF":{"name":"itemDeleted","abstract":"

    A file or folder was marked as deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13itemRecoveredyA2CmF":{"name":"itemRecovered","abstract":"

    A file or folder was recovered out of the trash.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17collaboratorAddedyA2CmF":{"name":"collaboratorAdded","abstract":"

    A collaborator was added to a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23collaboratorRoleChangedyA2CmF":{"name":"collaboratorRoleChanged","abstract":"

    A collaborator had their role changed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19collaboratorInvitedyA2CmF":{"name":"collaboratorInvited","abstract":"

    A collaborator was invited on a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19collaboratorRemovedyA2CmF":{"name":"collaboratorRemoved","abstract":"

    A collaborator was removed from a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8itemSyncyA2CmF":{"name":"itemSync","abstract":"

    A folder was marked for sync.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemUnsyncyA2CmF":{"name":"itemUnsync","abstract":"

    A folder was un-marked for sync.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemRenamedyA2CmF":{"name":"itemRenamed","abstract":"

    A file or folder was renamed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21itemEnabledForSharingyA2CmF":{"name":"itemEnabledForSharing","abstract":"

    A file or folder was enabled for sharing.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22itemDisabledForSharingyA2CmF":{"name":"itemDisabledForSharing","abstract":"

    A file or folder was disabled for sharing.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemSharedyA2CmF":{"name":"itemShared","abstract":"

    A folder was shared.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22itemMadeCurrentVersionyA2CmF":{"name":"itemMadeCurrentVersion","abstract":"

    A previous version of a file was promoted to the current version.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8tagAddedyA2CmF":{"name":"tagAdded","abstract":"

    A Tag was added to a file or folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16twoFactorEnabledyA2CmF":{"name":"twoFactorEnabled","abstract":"

    2 factor authentication enabled by user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19adminInviteAcceptedyA2CmF":{"name":"adminInviteAccepted","abstract":"

    Free user accepts invitation to become a managed user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19adminInviteRejectedyA2CmF":{"name":"adminInviteRejected","abstract":"

    Free user rejects invitation to become a managed user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13accessGrantedyA2CmF":{"name":"accessGranted","abstract":"

    Granted Box access to account.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13accessRevokedyA2CmF":{"name":"accessRevoked","abstract":"

    Revoke Box access to account.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16addedUserToGroupyA2CmF":{"name":"addedUserToGroup","abstract":"

    Added user to group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20removedUserFromGroupyA2CmF":{"name":"removedUserFromGroup","abstract":"

    Removed user from group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11createdUseryA2CmF":{"name":"createdUser","abstract":"

    Created user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12createdGroupyA2CmF":{"name":"createdGroup","abstract":"

    Created new group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12deletedGroupyA2CmF":{"name":"deletedGroup","abstract":"

    Deleted group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11deletedUseryA2CmF":{"name":"deletedUser","abstract":"

    Deleted user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11editedGroupyA2CmF":{"name":"editedGroup","abstract":"

    Edited group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10editedUseryA2CmF":{"name":"editedUser","abstract":"

    Edited user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10adminLoginyA2CmF":{"name":"adminLogin","abstract":"

    Admin login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21addedDeviceAssocationyA2CmF":{"name":"addedDeviceAssocation","abstract":"

    Added device association

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22changeFolderPermissionyA2CmF":{"name":"changeFolderPermission","abstract":"

    Edit the permissions on a folder

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11failedLoginyA2CmF":{"name":"failedLogin","abstract":"

    Failed login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO5loginyA2CmF":{"name":"login","abstract":"

    Login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24removedDeviceAssociationyA2CmF":{"name":"removedDeviceAssociation","abstract":"

    Removed device association

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22deviceTrustCheckFailedyA2CmF":{"name":"deviceTrustCheckFailed","abstract":"

    Device Trust check failed

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22termsOfServiceAcceptedyA2CmF":{"name":"termsOfServiceAccepted","abstract":"

    Accepted terms

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22termsOfServiceRejectedyA2CmF":{"name":"termsOfServiceRejected","abstract":"

    Rejected terms

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19fileMarkedMaliciousyA2CmF":{"name":"fileMarkedMalicious","abstract":"

    Virus found on a file. Event is only received by enterprises that have opted in to be notified.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6copiedyA2CmF":{"name":"copied","abstract":"

    Copied

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO7deletedyA2CmF":{"name":"deleted","abstract":"

    Deleted

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10downloadedyA2CmF":{"name":"downloaded","abstract":"

    Downloaded

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6editedyA2CmF":{"name":"edited","abstract":"

    Edited

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6lockedyA2CmF":{"name":"locked","abstract":"

    Locked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO5movedyA2CmF":{"name":"moved","abstract":"

    Moved

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9previewedyA2CmF":{"name":"previewed","abstract":"

    Previewed

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO7renamedyA2CmF":{"name":"renamed","abstract":"

    A file or folder name or description is changed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17storageExpirationyA2CmF":{"name":"storageExpiration","abstract":"

    Set file auto-delete

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9undeletedyA2CmF":{"name":"undeleted","abstract":"

    Undeleted

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8unlockedyA2CmF":{"name":"unlocked","abstract":"

    Unlocked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8uploadedyA2CmF":{"name":"uploaded","abstract":"

    Uploaded

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12shareEnabledyA2CmF":{"name":"shareEnabled","abstract":"

    Enabled shared links

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16itemShareUpdatedyA2CmF":{"name":"itemShareUpdated","abstract":"

    Share links settings updated

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22shareExpirationUpdatedyA2CmF":{"name":"shareExpirationUpdated","abstract":"

    Extend shared link expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15shareExpirationyA2CmF":{"name":"shareExpiration","abstract":"

    Set shared link expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8unsharedyA2CmF":{"name":"unshared","abstract":"

    Unshared shared link

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21collaborationAcceptedyA2CmF":{"name":"collaborationAccepted","abstract":"

    Accepted invites

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24collaborationRoleChangedyA2CmF":{"name":"collaborationRoleChanged","abstract":"

    Changed user roles

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO31collaborationExpirationExtendedyA2CmF":{"name":"collaborationExpirationExtended","abstract":"

    Extend collaborator expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20collaborationRemovedyA2CmF":{"name":"collaborationRemoved","abstract":"

    Removed collaborators

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22invitedToCollaborationyA2CmF":{"name":"invitedToCollaboration","abstract":"

    Invited

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23collaborationExpirationyA2CmF":{"name":"collaborationExpiration","abstract":"

    Set collaborator expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24loginActivityDeviceAddedyA2CmF":{"name":"loginActivityDeviceAdded","abstract":"

    A user is logging in from a device we haven’t seen before.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26loginActivityDeviceRemovedyA2CmF":{"name":"loginActivityDeviceRemoved","abstract":"

    We invalidated a user session associated with an app.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO28userOAuth2AccessTokenCreatedyA2CmF":{"name":"userOAuth2AccessTokenCreated","abstract":"

    An OAuth 2.0 access token has been created

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20userAdminRoleChangedyA2CmF":{"name":"userAdminRoleChanged","abstract":"

    When an admin role changes for a user

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO35contentWorkflowUploadPolicyViolatedyA2CmF":{"name":"contentWorkflowUploadPolicyViolated","abstract":"

    A collaborator violated an admin-set upload policy

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15contentAccessedyA2CmF":{"name":"contentAccessed","abstract":"

    A content was accessed by a user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataInstanceCreatedyA2CmF":{"name":"metadataInstanceCreated","abstract":"

    Creation of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23matadataInstanceUpdatedyA2CmF":{"name":"matadataInstanceUpdated","abstract":"

    Update of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23matadataInstanceDeletedyA2CmF":{"name":"matadataInstanceDeleted","abstract":"

    Deletion of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21taskAssignmentUpdatedyA2CmF":{"name":"taskAssignmentUpdated","abstract":"

    Update of a task assignment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21taskAssignmentDeletedyA2CmF":{"name":"taskAssignmentDeleted","abstract":"

    A task assignment is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11taskUpdatedyA2CmF":{"name":"taskUpdated","abstract":"

    A task’s comment was edited.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16itemAddedToGroupyA2CmF":{"name":"itemAddedToGroup","abstract":"

    An item is added to a group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20dataRetentionRemovedyA2CmF":{"name":"dataRetentionRemoved","abstract":"

    Retention is removed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20dataRetentionCreatedyA2CmF":{"name":"dataRetentionCreated","abstract":"

    Retention is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO34dataRetentionPolicyAssignmentAddedyA2CmF":{"name":"dataRetentionPolicyAssignmentAdded","abstract":"

    A retention policy assignment is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26legalHoldAssignmentCreatedyA2CmF":{"name":"legalHoldAssignmentCreated","abstract":"

    A legal hold assignment is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26legalHoldAssignmentDeletedyA2CmF":{"name":"legalHoldAssignmentDeleted","abstract":"

    A legal hold assignment is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyCreatedyA2CmF":{"name":"legalHoldPolicyCreated","abstract":"

    A legal hold policy is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyUpdatedyA2CmF":{"name":"legalHoldPolicyUpdated","abstract":"

    A legal hold policy is updated.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyDeletedyA2CmF":{"name":"legalHoldPolicyDeleted","abstract":"

    A legal hold policy is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22sharingPolicyViolationyA2CmF":{"name":"sharingPolicyViolation","abstract":"

    There is a sharing policy violation.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO25applicationPublicKeyAddedyA2CmF":{"name":"applicationPublicKeyAdded","abstract":"

    An application public key is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO27applicationPublicKeyDeletedyA2CmF":{"name":"applicationPublicKeyDeleted","abstract":"

    An application public key is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO18applicationCreatedyA2CmF":{"name":"applicationCreated","abstract":"

    A new application was created in the Box developer console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO18contentPolicyAddedyA2CmF":{"name":"contentPolicyAdded","abstract":"

    A content policy is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15automationAddedyA2CmF":{"name":"automationAdded","abstract":"

    An automation is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17automationDeletedyA2CmF":{"name":"automationDeleted","abstract":"

    An automation is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23userEmailAliasConfirmedyA2CmF":{"name":"userEmailAliasConfirmed","abstract":"

    A user email alias is confirmed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21userEmailAliasRemovedyA2CmF":{"name":"userEmailAliasRemoved","abstract":"

    A user email alias is removed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14watermarkAddedyA2CmF":{"name":"watermarkAdded","abstract":"

    A watermark is added to a file.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16watermarkRemovedyA2CmF":{"name":"watermarkRemoved","abstract":"

    A watermark is removed from a file.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateCreatedyA2CmF":{"name":"metadataTemplateCreated","abstract":"

    Creation of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateUpdatedyA2CmF":{"name":"metadataTemplateUpdated","abstract":"

    Update of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateDeletedyA2CmF":{"name":"metadataTemplateDeleted","abstract":"

    Deletion of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemOpenedyA2CmF":{"name":"itemOpened","abstract":"

    Item was opened.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12itemModifiedyA2CmF":{"name":"itemModified","abstract":"

    Item was modified.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24abnormalDownloadActivityyA2CmF":{"name":"abnormalDownloadActivity","abstract":"

    When a policy set in the Admin console is triggered.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21itemsRemovedFromGroupyA2CmF":{"name":"itemsRemovedFromGroup","abstract":"

    Folders were removed from a group in the Admin console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO25watermarkedFileDownloadedyA2CmF":{"name":"watermarkedFileDownloaded","abstract":"

    A watermarked file was downloaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO33enterpriseAppAuthorizationUpdatedyA2CmF":{"name":"enterpriseAppAuthorizationUpdated","abstract":"

    When a JWT application has been authorized or reauthorized

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO27shieldJustificationApprovedyA2CmF":{"name":"shieldJustificationApproved","abstract":"

    A Shield justification is approved

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11shieldAlertyA2CmF":{"name":"shieldAlert","abstract":"

    Shield detected an anomalous download, session, location, or malicious content based on enterprise Shield rules

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19shieldAccessBlockedyA2CmF":{"name":"shieldAccessBlocked","abstract":"

    Access to an external collaboration is blocked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO33shieldBlockedMissingJustificationyA2CmF":{"name":"shieldBlockedMissingJustification","abstract":"

    Access to an external collaboration is blocked due to missing a justification

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19shieldInviteBlockedyA2CmF":{"name":"shieldInviteBlocked","abstract":"

    An invite to externally collaborate is blocked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO39shieldInviteBlockedMissingJustificationyA2CmF":{"name":"shieldInviteBlockedMissingJustification","abstract":"

    An invite to externally collaborate is blocked due to missing a justification

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom event type, that is not yet implemented in this SDK version.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of sync state.

    ","parent_name":"EventType"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO9ascendingyA2CmF":{"name":"ascending","abstract":"

    Items sorted in ascending order.

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO10descendingyA2CmF":{"name":"descending","abstract":"

    Items sorted in descending order.

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"OrderDirection"},"Enums/CommentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO7commentyAcA0C0CcACmF":{"name":"comment(_:)","abstract":"

    Comment type

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Debug description of an object

    ","parent_name":"CommentItem"},"Enums/CollaborationItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO6folderyAcA6FolderCcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Debug description of an object

    ","parent_name":"CollaborationItem"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO7inboundyA2CmF":{"name":"inbound","abstract":"

    Inbound collaboration direction

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO8outboundyA2CmF":{"name":"outbound","abstract":"

    Outbound collaboration direction

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO4bothyA2CmF":{"name":"both","abstract":"

    Bi-directional collaboration

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom scope for metadata template.

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"CollaborationDirection"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO6editoryA2CmF":{"name":"editor","abstract":"

    Editor role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO6vieweryA2CmF":{"name":"viewer","abstract":"

    Viewer role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO9previeweryA2CmF":{"name":"previewer","abstract":"

    Previewer rle

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO8uploaderyA2CmF":{"name":"uploader","abstract":"

    Uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO17previewerUploaderyA2CmF":{"name":"previewerUploader","abstract":"

    Preview uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO14viewerUploaderyA2CmF":{"name":"viewerUploader","abstract":"

    Viewer uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO7coOwneryA2CmF":{"name":"coOwner","abstract":"

    Co-owner role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO5owneryA2CmF":{"name":"owner","abstract":"

    Owner role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value of a role that was not yet implemented in this versison of SDK.

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO11descriptionSSvp":{"name":"description","abstract":"

    String representation of role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO8acceptedyA2CmF":{"name":"accepted","abstract":"

    Collaboration invitation accepted

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO7pendingyA2CmF":{"name":"pending","abstract":"

    Collaboration invitation is pending

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Collaboration invitation was rejected

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Collaboration invitation status of custom value that was not yet implemented in this version of SDK.

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO11descriptionSSvp":{"name":"description","abstract":"

    String representation of collaboration status.

    ","parent_name":"CollaborationStatus"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterO5valueyACyxGxcAEmlF":{"name":"value(_:)","abstract":"

    Specifies value that should be set to a parameter

    ","parent_name":"NullableParameter"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterO4nullyACyxGAEmlF":{"name":"null","abstract":"

    Empty value representing null

    ","parent_name":"NullableParameter"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterOAASERzlE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

    Encode the nullable parameter to either null or its encoded value

    ","parent_name":"NullableParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO6offsetyACSicACmF":{"name":"offset(_:)","abstract":"

    Offset

    ","parent_name":"PagingParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO6markeryACSSSgcACmF":{"name":"marker(_:)","abstract":"

    Marker

    ","parent_name":"PagingParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO14streamPositionyACSSSgcACmF":{"name":"streamPosition(_:)","abstract":"

    Stream position

    ","parent_name":"PagingParameter"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO7coadminyA2CmF":{"name":"coadmin","abstract":"

    Coadmin role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO5adminyA2CmF":{"name":"admin","abstract":"

    Admin role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO4useryA2CmF":{"name":"user","abstract":"

    User role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom role that is not yet implemented

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of user’s role.

    ","parent_name":"UserRole"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO6activeyA2CmF":{"name":"active","abstract":"

    User is active

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO8inactiveyA2CmF":{"name":"inactive","abstract":"

    User is inactive

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO18cannotDeleteOrEdityA2CmF":{"name":"cannotDeleteOrEdit","abstract":"

    User cannot delete or edit content

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO24cannotDeleteEditOrUploadyA2CmF":{"name":"cannotDeleteEditOrUpload","abstract":"

    User cannot delete, edit or upload content

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom user status that is not yet implemented

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of user status.

    ","parent_name":"UserStatus"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO7managedyA2CmF":{"name":"managed","abstract":"

    The ToS is allowed to be accepted/rejected by managed users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO8externalyA2CmF":{"name":"external","abstract":"

    The ToS is allowed to be accepted/rejected by external users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of scope of the ToS to the end users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO7enabledyA2CmF":{"name":"enabled","abstract":"

    The ToS is currently enabled and active.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO8disabledyA2CmF":{"name":"disabled","abstract":"

    The ToS is currently disabled and inactive.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO11descriptionSSvp":{"name":"description","abstract":"

    String representation of active/inactive indicator for ToS.

    ","parent_name":"TermsOfServiceStatus"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO4fileyA2CmF":{"name":"file","abstract":"

    Object type file

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO6folderyA2CmF":{"name":"folder","abstract":"

    Object type folder

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO7webLinkyA2CmF":{"name":"webLink","abstract":"

    Object type weblink

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type defined for searching that is not yet implemented.

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of searched item type.

    ","parent_name":"SearchItemType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO4nameyA2CmF":{"name":"name","abstract":"

    Searching in names of items

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11descriptionyA2CmF":{"name":"description","abstract":"

    Searching in description of items

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO12fileContentsyA2CmF":{"name":"fileContents","abstract":"

    Searching in files content

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO8commentsyA2CmF":{"name":"comments","abstract":"

    Searching in comments

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO4tagsyA2CmF":{"name":"tags","abstract":"

    Searching in tags

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom attribute defined for searching that is not yet implemented.

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of search area type

    ","parent_name":"SearchContentType"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO4useryA2CmF":{"name":"user","abstract":"

    Scope limited to current user

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    Scope limited the enterprise.

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom search scope that is not yet implemented. To enable this type of scope for an administrator,","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of scope.

    ","parent_name":"SearchScope"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO4noneyA2CmF":{"name":"none","abstract":"

    Preserve the existing value on the file

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO9overwriteyA2CmF":{"name":"overwrite","abstract":"

    Force-apply the cascade policy’s value over any existing value.

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom conflict resolution method.

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"ConflictResolution"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO2idyA2CmF":{"name":"id","abstract":"

    Order by item identifier

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4nameyA2CmF":{"name":"name","abstract":"

    Order by item name

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4dateyA2CmF":{"name":"date","abstract":"

    Order by item date

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4typeyA2CmF":{"name":"type","abstract":"

    Order by item type

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented by the SDk

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO4openyA2CmF":{"name":"open","abstract":"

    Any user can upload.

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO13collaboratorsyA2CmF":{"name":"collaborators","abstract":"

    Any folder collaborator can upload

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access to a folder’s upload email address that is not yet implemented.

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO11descriptionSSvp":{"name":"description","abstract":"

    Returns a string representation of the folder upload email access

    ","parent_name":"FolderUploadEmailAccess"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO3jpgyA2CmF":{"name":"jpg","abstract":"

    The file extension for Joint Photographic Experts Group (JPEG) thumbnail images

    ","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO3pngyA2CmF":{"name":"png","abstract":"

    The file extension for Portable Network Graphic (PNG) thumbnail images

    ","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom file extension for thumbnail images that is not yet implemented. Check the list of","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of suffix

    ","parent_name":"ThumbnailExtension"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO6activeyA2CmF":{"name":"active","abstract":"

    Item was not deleted or moved to trash.

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO7trashedyA2CmF":{"name":"trashed","abstract":"

    Item has been moved to the trash

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO7deletedyA2CmF":{"name":"deleted","abstract":"

    Item has been permanently deleted

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"ItemStatus"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO9newChangeyA2CmF":{"name":"newChange","abstract":"

    New event appeared.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO9reconnectyA2CmF":{"name":"reconnect","abstract":"

    No new events appeared. Request for a new polling URL.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Value that was not yet implemented in this SDK

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO11descriptionSSvp":{"name":"description","abstract":"

    String representation of the reponse.

    ","parent_name":"EventObserverResponse"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO3allyA2CmF":{"name":"all","abstract":"

    Stream returns all user events

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO7changesyA2CmF":{"name":"changes","abstract":"

    Stream returns events that may cause file tree changes such as file updates or collaborations

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO4syncyA2CmF":{"name":"sync","abstract":"

    Stream returns enterprise-wide events available for administrators

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom stream type that is not yet implemented

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of StreamType

    ","parent_name":"StreamType"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO3nowyA2CmF":{"name":"now","abstract":"

    When used, Box API will return 0 events and the latest streamPosition value to be used for subsequent call.

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO4zeroyA2CmF":{"name":"zero","abstract":"

    When used, Box API will return all available events.

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value of a stream position used when using value not yet implemented in this SDK (of similar usage as none, now or zero)

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of StreamPosition

    ","parent_name":"StreamPosition"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO4useryA2CmF":{"name":"user","abstract":"

    The user that is granted access

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO5groupyA2CmF":{"name":"group","abstract":"

    The group that is granted access

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access that is not yet implemented

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"AccessibleBy"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO12networkAgentyA2CmF":{"name":"networkAgent","abstract":"

    NetworkAgent related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO7modulesyA2CmF":{"name":"modules","abstract":"

    Module related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO6clientyA2CmF":{"name":"client","abstract":"

    BoxCLient related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO3sdkyA2CmF":{"name":"sdk","abstract":"

    The general log for BoxSDK

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO11descriptionSSvp":{"name":"description","abstract":"

    Log category string title

    ","parent_name":"LogCategory"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5debugyA2CmF":{"name":"debug","abstract":"

    Logging only while debugging

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO4infoyA2CmF":{"name":"info","abstract":"

    Logging info message

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5erroryA2CmF":{"name":"error","abstract":"

    Logging error

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5fatalyA2CmF":{"name":"fatal","abstract":"

    Logging fatal error

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO11descriptionSSvp":{"name":"description","abstract":"

    Log level string title

    ","parent_name":"LogLevel"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    The scope of the metadata template is set to the entire “enterprise”.

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO6globalyA2CmF":{"name":"global","abstract":"

    The scope of the metadata template is set to “global”

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom scope for metadata template.

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"MetadataScope"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO8lessThanyA2CmF":{"name":"lessThan","abstract":"

    Inclusive upper bound parameter for field values of floats and dates.

    ","parent_name":"MetadataFilterBound"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO11greaterThanyA2CmF":{"name":"greaterThan","abstract":"

    Inclusive lower bound parameter for field values of floats and dates.

    ","parent_name":"MetadataFilterBound"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO5equalyA2CmF":{"name":"equal","abstract":"

    Set the filter value equal to filter key.

    ","parent_name":"MetadataFilterBound"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO15clientDestroyedyA2CmF":{"name":"clientDestroyed","abstract":"

    Box client was destroyed

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO10invalidURLyACSS_tcACmF":{"name":"invalidURL(urlString:)","abstract":"

    URL is invalid

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO8notFoundyACSScACmF":{"name":"notFound(_:)","abstract":"

    The requested resource was not found

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19instanceDeallocatedyACSScACmF":{"name":"instanceDeallocated(_:)","abstract":"

    Object needed in closure was deallocated

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO27keychainDataConversionErroryA2CmF":{"name":"keychainDataConversionError","abstract":"

    Could not decode or encode keychain data

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO15keychainNoValueyA2CmF":{"name":"keychainNoValue","abstract":"

    Value not found in Keychain

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO22keychainUnhandledErroryACSScACmF":{"name":"keychainUnhandledError(_:)","abstract":"

    Unhandled keychain error

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19rateLimitMaxRetriesyA2CmF":{"name":"rateLimitMaxRetries","abstract":"

    Request has hit the maximum number of retries

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12typeMismatchyACSS_tcACmF":{"name":"typeMismatch(key:)","abstract":"

    Value for key is of an unexpected type

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO13valueMismatchyACSS_SSSaySSGtcACmF":{"name":"valueMismatch(key:value:acceptedValues:)","abstract":"

    Value for key is not one of the accepted values

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO18invalidValueFormatyACSS_tcACmF":{"name":"invalidValueFormat(key:)","abstract":"

    Value for key is of a valid type, but was not able to convert value to expected type

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO10notPresentyACSS_tcACmF":{"name":"notPresent(key:)","abstract":"

    Key was not present

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO28representationCreationFailedyA2CmF":{"name":"representationCreationFailed","abstract":"

    The file representation couldn’t be made

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO17tokenStoreFailureyA2CmF":{"name":"tokenStoreFailure","abstract":"

    Error with TokenStore operation (write, read or clear)

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO14tokenRetrievalyA2CmF":{"name":"tokenRetrieval","abstract":"

    Unsuccessful token retrieval. Token not found

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO33invalidOAuthRedirectConfigurationyA2CmF":{"name":"invalidOAuthRedirectConfiguration","abstract":"

    OAuth web session authorization failed due to invalid redirect configuration

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO17invalidOAuthStateyA2CmF":{"name":"invalidOAuthState","abstract":"

    Couldn’t obtain authorization code from OAuth web session result

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO18unauthorizedAccessyA2CmF":{"name":"unauthorizedAccess","abstract":"

    Unauthorized request to API

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO20refreshTokenNotFoundyA2CmF":{"name":"refreshTokenNotFound","abstract":"

    Unsuccessful refresh token retrieval. Token not found in the retrieved TokenInfo object

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12expiredTokenyA2CmF":{"name":"expiredToken","abstract":"

    Access token has expired

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12jwtAuthErroryA2CmF":{"name":"jwtAuthError","abstract":"

    Authorization with JWT token failed

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19nonIterableResponseyA2CmF":{"name":"nonIterableResponse","abstract":"

    Couldn’t create paging iterable for non-paged response

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO9endOfListyA2CmF":{"name":"endOfList","abstract":"

    The end of the list was reached

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom error message

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:s26ExpressibleByStringLiteralP06stringD0x0cD4TypeQz_tcfc":{"name":"init(stringLiteral:)","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html":{"name":"BoxSDKErrorEnum","abstract":"

    Box SDK Error

    "},"Enums/MetadataFilterBound.html":{"name":"MetadataFilterBound","abstract":"

    Defines the the relation between the filter key and filter value of a metadata template.

    "},"Enums/MetadataScope.html":{"name":"MetadataScope","abstract":"

    Defines the scope of the metadata template.

    "},"Enums/LogLevel.html":{"name":"LogLevel","abstract":"

    Defines character of the log and when it will be displayed

    "},"Enums/LogCategory.html":{"name":"LogCategory","abstract":"

    Defines log category based on what kind of data is being logged

    "},"Enums/AccessibleBy.html":{"name":"AccessibleBy","abstract":"

    Specifies type of value that has granted access to an object.

    "},"Enums/StreamPosition.html":{"name":"StreamPosition","abstract":"

    Stream position used for stream pagination

    "},"Enums/StreamType.html":{"name":"StreamType","abstract":"

    Restricts the types of events returned.

    "},"Enums/EventObserverResponse.html":{"name":"EventObserverResponse","abstract":"

    Defines results for a request checking for new changes in user events

    "},"Enums/ItemStatus.html":{"name":"ItemStatus","abstract":"

    Box item status indicating whether this item is deleted or not.

    "},"Enums/ThumbnailExtension.html":{"name":"ThumbnailExtension","abstract":"

    Defines the file extension of a thumbnail image file.

    "},"Enums/FolderUploadEmailAccess.html":{"name":"FolderUploadEmailAccess","abstract":"

    Defines the level of access to upload a file to a folder via its upload email address

    "},"Enums/FolderItemsOrderBy.html":{"name":"FolderItemsOrderBy","abstract":"

    Defines by which parameter should list of box items be ordered.

    "},"Enums/ConflictResolution.html":{"name":"ConflictResolution","abstract":"

    The desired behavior for conflict-resolution if a template already exists on a given file or folder

    "},"Enums/SearchScope.html":{"name":"SearchScope","abstract":"

    Defines search scope

    "},"Enums/SearchContentType.html":{"name":"SearchContentType","abstract":"

    Defines the attributes for which the search should look for matches

    "},"Enums/SearchItemType.html":{"name":"SearchItemType","abstract":"

    Defines type of objects to include in the search results

    "},"Enums/TermsOfServiceStatus.html":{"name":"TermsOfServiceStatus","abstract":"

    Specifies whether the Terms of Service is currently active or inactive.

    "},"Enums/TermsOfServiceType.html":{"name":"TermsOfServiceType","abstract":"

    Specifies whether the ToS is managed by an enterprise or external to an enterprise.

    "},"Enums/UserStatus.html":{"name":"UserStatus","abstract":"

    Defines user status.

    "},"Enums/UserRole.html":{"name":"UserRole","abstract":"

    Defines user’s role within an enterprise

    "},"Enums/PagingParameter.html":{"name":"PagingParameter","abstract":"

    Stores offset, marker or stream position for the iterator

    "},"Enums/NullableParameter.html":{"name":"NullableParameter","abstract":"

    Type for updating optional parameters - parameters that can either have value of some type, or be nil."},"Enums/CollaborationStatus.html":{"name":"CollaborationStatus","abstract":"

    The status of the collaboration invitation.

    "},"Enums/CollaborationRole.html":{"name":"CollaborationRole","abstract":"

    The level of access granted. To see exactly which role has which permission, please look here

    "},"Enums/CollaborationDirection.html":{"name":"CollaborationDirection","abstract":"

    Direction of the collaboration

    "},"Enums/CollaborationItem.html":{"name":"CollaborationItem","abstract":"

    The file or folder that access is granted to by collaboration.

    "},"Enums/CommentItem.html":{"name":"CommentItem","abstract":"

    Item a comment was placed on

    "},"Enums/OrderDirection.html":{"name":"OrderDirection","abstract":"

    Order direction.

    "},"Enums/EventType.html":{"name":"EventType","abstract":"

    Defines user or enterprise event type

    "},"Enums/FileRepresentationHint.html":{"name":"FileRepresentationHint","abstract":"

    Defines the file type for the generated file representation

    "},"Enums/SyncState.html":{"name":"SyncState","abstract":"

    Defines whether folder will be synced by the Box sync clients or not.

    "},"Enums/FolderItem.html":{"name":"FolderItem","abstract":"

    Files, folders, or web links contained within a folder.

    "},"Enums/GroupInvitabilityLevel.html":{"name":"GroupInvitabilityLevel","abstract":"

    Specifies who can invite the group to collaborate on folders.

    "},"Enums/GroupMemberViewabilityLevel.html":{"name":"GroupMemberViewabilityLevel","abstract":"

    Specifies who can view the members of the group.

    "},"Enums/GroupRole.html":{"name":"GroupRole","abstract":"

    Specifies role of the user within a Group.

    "},"Enums/FileMetadataOperation.html":{"name":"FileMetadataOperation","abstract":"

    Operations on a file metadata

    "},"Enums/FolderMetadataOperation.html":{"name":"FolderMetadataOperation","abstract":"

    Operations on a folder metadata

    "},"Enums/MetadataTemplateOperation.html":{"name":"MetadataTemplateOperation","abstract":"

    Specifies opperations available on metadata template

    "},"Enums/RetentionPolicyType.html":{"name":"RetentionPolicyType","abstract":"

    The type of the retention policy.

    "},"Enums/DispositionAction.html":{"name":"DispositionAction","abstract":"

    The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    "},"Enums/RetentionPolicyStatus.html":{"name":"RetentionPolicyStatus","abstract":"

    The status of the retention policy.

    "},"Enums/RetentionPolicyAssignmentItemType.html":{"name":"RetentionPolicyAssignmentItemType","abstract":"

    Item type with task assignment.

    "},"Enums/TokenScope.html":{"name":"TokenScope","abstract":"

    Specifies permissions that define a token scope

    "},"Enums/SharedLinkAccess.html":{"name":"SharedLinkAccess","abstract":"

    Defines the level of access to the item by its shared link.

    "},"Enums/SignRequestStatus.html":{"name":"SignRequestStatus","abstract":"

    Describes the status of the sign request.

    "},"Enums/SignRequestSignerRole.html":{"name":"SignRequestSignerRole","abstract":"

    Defines the role of the signer in the sign request.

    "},"Enums/SignRequestSignerDecisionType.html":{"name":"SignRequestSignerDecisionType","abstract":"

    Type of decision made by the signer

    "},"Enums/SignRequestSignerInputType.html":{"name":"SignRequestSignerInputType","abstract":"

    Represents a type of input.

    "},"Enums/TaskCompletionRule.html":{"name":"TaskCompletionRule","abstract":"

    Defines the condition that will mark a task as complete

    "},"Enums/TaskAction.html":{"name":"TaskAction","abstract":"

    The action the task assignee will be prompted to perform

    "},"Enums/AssignmentStatus.html":{"name":"AssignmentStatus","abstract":"

    Status of assignment.

    "},"Enums/AssignmentState.html":{"name":"AssignmentState","abstract":"

    State of assignment.

    "},"Enums/TaskItem.html":{"name":"TaskItem","abstract":"

    Item a task is assigned to

    "},"Enums/WebhookItem.html":{"name":"WebhookItem","abstract":"

    Files, folders, or web links associated with a webhook.

    "},"Classes/KeychainTokenStore.html#/s:6BoxSDK18KeychainTokenStoreCACycfc":{"name":"init()","abstract":"

    Initializer method

    ","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP4read10completionyys6ResultOyAA0C4InfoCs5Error_pGc_tF":{"name":"read(completion:)","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP5write9tokenInfo10completionyAA0cG0C_ys6ResultOyyts5Error_pGctF":{"name":"write(tokenInfo:completion:)","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP5clear10completionyys6ResultOyyts5Error_pGc_tF":{"name":"clear(completion:)","parent_name":"KeychainTokenStore"},"Classes/SingleTokenSession.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","parent_name":"SingleTokenSession"},"Classes/SingleTokenSession.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","parent_name":"SingleTokenSession"},"Classes/SingleTokenSession.html#/s:6BoxSDK18SingleTokenSessionC09downscopeD05scope8resource10sharedLink10completionyShyAA0D5ScopeOG_SSSgALys6ResultOyAA0D4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"SingleTokenSession"},"Classes/OAuth2Session.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK20ExpiredTokenHandlingP06handlecD010completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"handleExpiredToken(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK13OAuth2SessionC12refreshToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"refreshToken(completion:)","abstract":"

    Gets refreshed access token if necessary

    ","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK13OAuth2SessionC14downscopeToken5scope8resource10sharedLink10completionyShyAA0F5ScopeOG_SSSgALys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"OAuth2Session"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","abstract":"

    Revokes token

    ","parent_name":"DelegatedAuthSession"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","abstract":"

    Retrieves valid access token

    ","parent_name":"DelegatedAuthSession"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC14downscopeToken5scope8resource10sharedLink10completionyShyAA0G5ScopeOG_SSSgALys6ResultOyAA0G4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"DelegatedAuthSession"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC14totalFileCountSivp":{"name":"totalFileCount","abstract":"

    The total number of files in the zip

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC19downloadedFileCountSivp":{"name":"downloadedFileCount","abstract":"

    The number of files in the zip that were downloaded

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC16skippedFileCountSivp":{"name":"skippedFileCount","abstract":"

    The number of files that were skipped when downloading

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC18skippedFolderCountSivp":{"name":"skippedFolderCount","abstract":"

    The number of folders that were skipped when downloading

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC5stateSSvp":{"name":"state","abstract":"

    State of the download for the zip file

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC13nameConflictsSayAA0cD8ConflictCGSgvp":{"name":"nameConflicts","abstract":"

    Conflicts that occur between items that have the same name. This is always initially nil and updated manually later, via the FilesModule.getZipDownloadStatus() method.

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC2idSSvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC4typeSSvp":{"name":"type","abstract":"

    Box item type - file or folder.

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC12originalNameSSvp":{"name":"originalName","abstract":"

    The original name of the item that has the conflict

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC12downloadNameSSvp":{"name":"downloadName","abstract":"

    The new name of the item when it downloads that resolves the conflict

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadConflict"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK19ZipDownloadConflictC8conflictSayAA0cdE4ItemCGSgvp":{"name":"conflict","abstract":"

    Conflict that occurs between items that have the same name.

    ","parent_name":"ZipDownloadConflict"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK19ZipDownloadConflictC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadConflict"},"Classes/ZipDownload.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC11downloadUrl10Foundation3URLVvp":{"name":"downloadUrl","abstract":"

    The URL to download the Zip file. If entered in a browser, this URL will trigger a download of the Zip file.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC9statusUrl10Foundation3URLVvp":{"name":"statusUrl","abstract":"

    The URL to monitor the status of the download.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    Expiration date of the Zip file download.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC13nameConflictsSayAA0cD8ConflictCGSgvp":{"name":"nameConflicts","abstract":"

    Conflicts that occur between items that have the same name.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownload"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileUploadedyA2EmF":{"name":"fileUploaded","abstract":"

    A file is uploaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13filePreviewedyA2EmF":{"name":"filePreviewed","abstract":"

    A file is previewed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14fileDownloadedyA2EmF":{"name":"fileDownloaded","abstract":"

    A file is downloaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileTrashedyA2EmF":{"name":"fileTrashed","abstract":"

    A file is moved to the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileDeletedyA2EmF":{"name":"fileDeleted","abstract":"

    A file is permanently deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileRestoredyA2EmF":{"name":"fileRestored","abstract":"

    A file is restored from the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO10fileCopiedyA2EmF":{"name":"fileCopied","abstract":"

    A file is copied

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO9fileMovedyA2EmF":{"name":"fileMoved","abstract":"

    A file is moved from one folder to another

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO10fileLockedyA2EmF":{"name":"fileLocked","abstract":"

    A file is locked

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileUnlockedyA2EmF":{"name":"fileUnlocked","abstract":"

    A file is unlocked

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileRenamedyA2EmF":{"name":"fileRenamed","abstract":"

    A file was renamed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentCreatedyA2EmF":{"name":"commentCreated","abstract":"

    A comment object is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentUpdatedyA2EmF":{"name":"commentUpdated","abstract":"

    A comment object is edited

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentDeletedyA2EmF":{"name":"commentDeleted","abstract":"

    A comment object is removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21taskAssignmentCreatedyA2EmF":{"name":"taskAssignmentCreated","abstract":"

    A task is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21taskAssignmentUpdatedyA2EmF":{"name":"taskAssignmentUpdated","abstract":"

    A task assignment is changed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceCreatedyA2EmF":{"name":"metadataInstanceCreated","abstract":"

    A new metadata template instance is associated with a file or folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceUpdatedyA2EmF":{"name":"metadataInstanceUpdated","abstract":"

    An attribute (value) is updated/deleted for an existing metadata template instance associated with a file or folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceDeletedyA2EmF":{"name":"metadataInstanceDeleted","abstract":"

    An existing metadata template instance associated with a file or folder is deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderCreatedyA2EmF":{"name":"folderCreated","abstract":"

    A folder is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderRenamedyA2EmF":{"name":"folderRenamed","abstract":"

    A folder was renamed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO16folderDownloadedyA2EmF":{"name":"folderDownloaded","abstract":"

    A folder is downloaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14folderRestoredyA2EmF":{"name":"folderRestored","abstract":"

    A folder is restored from the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderDeletedyA2EmF":{"name":"folderDeleted","abstract":"

    A folder is permanently removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12folderCopiedyA2EmF":{"name":"folderCopied","abstract":"

    A copy of a folder is made

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11folderMovedyA2EmF":{"name":"folderMoved","abstract":"

    A folder is moved to a different folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderTrashedyA2EmF":{"name":"folderTrashed","abstract":"

    A folder is moved to the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14webhookDeletedyA2EmF":{"name":"webhookDeleted","abstract":"

    When a webhook is deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationCreatedyA2EmF":{"name":"collaborationCreated","abstract":"

    A collaboration is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21collaborationAcceptedyA2EmF":{"name":"collaborationAccepted","abstract":"

    A collaboration has been accepted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21collaborationRejectedyA2EmF":{"name":"collaborationRejected","abstract":"

    A collaboration has been rejected

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationRemovedyA2EmF":{"name":"collaborationRemoved","abstract":"

    A collaboration has been removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationUpdatedyA2EmF":{"name":"collaborationUpdated","abstract":"

    A collaboration has been updated

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkDeletedyA2EmF":{"name":"sharedLinkDeleted","abstract":"

    A shared link was deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkCreatedyA2EmF":{"name":"sharedLinkCreated","abstract":"

    A shared link was created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkUpdatedyA2EmF":{"name":"sharedLinkUpdated","abstract":"

    A shared link was updated

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html":{"name":"EventTriggers","abstract":"

    Event triggers for webhooks

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC6targetAA0C4ItemOSgvp":{"name":"target","abstract":"

    Target information

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    User that created the webhook

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    Timestamp of when webhook was created

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC7address10Foundation3URLVSgvp":{"name":"address","abstract":"

    URL to which notifications are sent

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC8triggersSayAC13EventTriggersOGSgvp":{"name":"triggers","abstract":"

    Events that activate the webhook

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Webhook"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Can rename web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Can delete web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV10canCommentSbSgvp":{"name":"canComment","abstract":"

    Can comment on web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Can share web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Can set share access for web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html":{"name":"Permissions","abstract":"

    Web link permissions

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this web link. Used with If-Match headers.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4nameSSSgvp":{"name":"name","abstract":"

    The name of this web link.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    The URL this web link points to.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When this web link was created

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this web link was last updated

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    The parent object the web link belongs to.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC11descriptionSSSgvp":{"name":"description","abstract":"

    The description accompanying the web link. This is visible within the Box web application.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10itemStatusAA04ItemF0OSgvp":{"name":"itemStatus","abstract":"

    Status of the web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When this web link was last moved to the trash

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When this web link will be permanently deleted.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC06sharedD0AA06SharedD0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this web link. Is nil if no shared link has been created.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC14pathCollectionAA04PathF0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this link, starting at the root

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last modified this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Web link permissions

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"WebLink"},"Classes/Watermark.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC11resourceKeySSvpZ":{"name":"resourceKey","abstract":"

    Key for watermark data JSON object

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC10imprintKeySSvpZ":{"name":"imprintKey","abstract":"

    Key for imprint data in JSON object

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC14defaultImprintSSvpZ":{"name":"defaultImprint","abstract":"

    Default imprint text

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time this watermark was created.

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time this watermark was last modified.

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Watermark"},"Classes/User/TrackingCode.html#/s:6BoxSDK4UserC12TrackingCodeV4nameSSvp":{"name":"name","abstract":"

    Code name

    ","parent_name":"TrackingCode"},"Classes/User/TrackingCode.html#/s:6BoxSDK4UserC12TrackingCodeV5valueSSvp":{"name":"value","abstract":"

    Code value

    ","parent_name":"TrackingCode"},"Classes/User/TrackingCode.html":{"name":"TrackingCode","abstract":"

    A custom values set by the user’s admin to track user’s activity.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4nameSSSgvp":{"name":"name","abstract":"

    The name of the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC5loginSSSgvp":{"name":"login","abstract":"

    The email address the user uses to log in.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the user object was created.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the user object was last modified.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8languageSSSgvp":{"name":"language","abstract":"

    The user’s preferred language.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8timezoneSSSgvp":{"name":"timezone","abstract":"

    The user’s timezone.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC11spaceAmountSiSgvp":{"name":"spaceAmount","abstract":"

    The user’s total available space amount in bytes.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9spaceUsedSiSgvp":{"name":"spaceUsed","abstract":"

    The amount of space in use by the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13maxUploadSizeSiSgvp":{"name":"maxUploadSize","abstract":"

    The maximum individual file size in bytes the user can have.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC6statusAA0C6StatusOSgvp":{"name":"status","abstract":"

    User’s status.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8jobTitleSSSgvp":{"name":"jobTitle","abstract":"

    The user’s job title.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC5phoneSSSgvp":{"name":"phone","abstract":"

    The user’s phone number.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC7addressSSSgvp":{"name":"address","abstract":"

    The user’s address.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9avatarUrl10Foundation3URLVSgvp":{"name":"avatarUrl","abstract":"

    URL of the user’s avatar image.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4roleSSSgvp":{"name":"role","abstract":"

    The user’s enterprise role.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13trackingCodesSayAC12TrackingCodeVGSgvp":{"name":"trackingCodes","abstract":"

    An array of key/value pairs set by the user’s admin.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC18canSeeManagedUsersSbSgvp":{"name":"canSeeManagedUsers","abstract":"

    Whether the user can see other enterprise users in their contact list.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13isSyncEnabledSbSgvp":{"name":"isSyncEnabled","abstract":"

    Whether the user can use Box Sync.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC26isExternalCollabRestrictedSbSgvp":{"name":"isExternalCollabRestricted","abstract":"

    Whether the user is allowed to collaborate with users outside her enterprise.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC24isExemptFromDeviceLimitsSbSgvp":{"name":"isExemptFromDeviceLimits","abstract":"

    Whether to exempt the user from Enterprise device limits.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC29isExemptFromLoginVerificationSbSgvp":{"name":"isExemptFromLoginVerification","abstract":"

    Whether the user must use two-factor authentication.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the user’s enterprise.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC6myTagsSaySSGSgvp":{"name":"myTags","abstract":"

    Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8hostnameSSSgvp":{"name":"hostname","abstract":"

    The root (protocol, subdomain, domain) of any links that need to be generated for the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC20isPlatformAccessOnlySbSgvp":{"name":"isPlatformAccessOnly","abstract":"

    Whether the user is an App User.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC011externalAppC2IdSSSgvp":{"name":"externalAppUserId","abstract":"

    External app user ID.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"User"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV9listParts10Foundation3URLVSgvp":{"name":"listParts","abstract":"

    List parts endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV6commit10Foundation3URLVSgvp":{"name":"commit","abstract":"

    Commit part endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV8logEvent10Foundation3URLVSgvp":{"name":"logEvent","abstract":"

    Log event endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV10uploadPart10Foundation3URLVSgvp":{"name":"uploadPart","abstract":"

    Upload part endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV6status10Foundation3URLVSgvp":{"name":"status","abstract":"

    Upload status endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV5abort10Foundation3URLVSgvp":{"name":"abort","abstract":"

    Abort upload endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html":{"name":"UploadSessionEndpoints","abstract":"

    Internal struct containing URLs for upload session manipulation

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC10totalPartsSivp":{"name":"totalParts","abstract":"

    Count of uploaded parts

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC8partSizeSivp":{"name":"partSize","abstract":"

    Size of uploaded part. Each part’s size must be exactly equal in size to the part size specified","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC17numPartsProcessedSivp":{"name":"numPartsProcessed","abstract":"

    Number of parts processed

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC16sessionExpiresAt10Foundation4DateVvp":{"name":"sessionExpiresAt","abstract":"

    The validity end of this session

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC16sessionEndpointsAC0cdF0Vvp":{"name":"sessionEndpoints","abstract":"

    Set of URL for upload session management

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"UploadSession"},"Classes/UploadPart.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"UploadPart"},"Classes/UploadPart.html#/s:6BoxSDK10UploadPartC4partAA0cD11DescriptionVvp":{"name":"part","abstract":"

    Part description object

    ","parent_name":"UploadPart"},"Classes/UploadPart.html#/s:6BoxSDK10UploadPartC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"UploadPart"},"Classes/TrackingCode.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC4nameSSvp":{"name":"name","abstract":"

    Tracking code key.

    ","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC5valueSSvp":{"name":"value","abstract":"

    Tracking code value.

    ","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TrackingCode"},"Classes/TokenInfo.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC06accessC007refreshC09expiresIn9tokenTypeACSS_SSSgSdSStcfc":{"name":"init(accessToken:refreshToken:expiresIn:tokenType:)","abstract":"

    Initializer

    ","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC06accessC09expiresInACSS_Sdtcfc":{"name":"init(accessToken:expiresIn:)","abstract":"

    Initializer.

    ","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compares tokens

    ","parent_name":"TokenInfo"},"Classes/Token.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC06accessC0SSSgvp":{"name":"accessToken","abstract":"

    Access token.

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC9expiresInSiSgvp":{"name":"expiresIn","abstract":"

    Expiration time interval since

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC9tokenTypeSSSgvp":{"name":"tokenType","abstract":"

    Type of token

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC12restrictedToSayAA5ScopeCGSgvp":{"name":"restrictedTo","abstract":"

    Token permissions

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Token"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC2idSSvp":{"name":"id","abstract":"

    The ID of the user status object for the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC3tosAA0cdE0CSgvp":{"name":"tos","abstract":"

    The Terms of Service this status is associated with.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4userAA0F0CSgvp":{"name":"user","abstract":"

    The user that is associated with the current status of the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC10isAcceptedSbSgvp":{"name":"isAccepted","abstract":"

    Indicator as to whether or not the user has accepted the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date the user status for the ToS was created.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date the user status for the ToS was modified.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC6statusAA0cdE6StatusOSgvp":{"name":"status","abstract":"

    An enum indicating whether the ToS is currently active or inactive.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    A mini Box enterprise object that the ToS is associated with.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC7tosTypeAA0cdeG0OSgvp":{"name":"tosType","abstract":"

    The scope of the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4textSSSgvp":{"name":"text","abstract":"

    The agreement of the ToS specified for the user in the custom application.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date created at for the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date modified at for the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfService"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    File an assignment is on.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    Date of assignment.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC6statusAA0D6StatusOSgvp":{"name":"status","abstract":"

    Assignment status.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC7messageSSSgvp":{"name":"message","abstract":"

    A message from the assignee about this task.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedToAA4UserCSgvp":{"name":"assignedTo","abstract":"

    The user task is assigned to.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    The user task is assigned by.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC15resolutionStateAA0dF0OSgvp":{"name":"resolutionState","abstract":"

    State of assignment. Can be completed, incomplete, approved, or rejected.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TaskAssignment"},"Classes/Task.html#/s:6BoxSDK4TaskC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The file associated with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC5dueAt10Foundation4DateVSgvp":{"name":"dueAt","abstract":"

    When the task is due.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC6actionAA0C6ActionOSgvp":{"name":"action","abstract":"

    The action the task assignee will be prompted to do. Depending on task type, this can be “review” or “complete”.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC7messageSSSgvp":{"name":"message","abstract":"

    A message that will be included with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC24taskAssignmentCollectionAA14EntryContainerCyAA0cE0CGSgvp":{"name":"taskAssignmentCollection","abstract":"

    A collection of mini task_assignment objects associated with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC11isCompletedSbSgvp":{"name":"isCompleted","abstract":"

    Whether the task has been completed.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the task object was created.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC14completionRuleAA0c10CompletionE0OSgvp":{"name":"completionRule","abstract":"

    The rule that determines whether a task is completed

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Task"},"Classes/StoragePolicyAssignment/AssignedTo.html#/s:6BoxSDK23StoragePolicyAssignmentC10AssignedToV4typeSSvp":{"name":"type","abstract":"

    Type of item storage policy is assigned to

    ","parent_name":"AssignedTo"},"Classes/StoragePolicyAssignment/AssignedTo.html#/s:6BoxSDK23StoragePolicyAssignmentC10AssignedToV2idSSvp":{"name":"id","abstract":"

    Id of item storage policy is assigned to

    ","parent_name":"AssignedTo"},"Classes/StoragePolicyAssignment/AssignedTo.html":{"name":"AssignedTo","abstract":"

    Enterprise storage policy is assigned to

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Id of the storage policy assignment

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC07storageD0AA0cD0CSgvp":{"name":"storagePolicy","abstract":"

    Storage policy

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC10assignedToAC08AssignedG0VSgvp":{"name":"assignedTo","abstract":"

    Enterprise the storage policy is assigned to

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC2idSSvp":{"name":"id","abstract":"

    Id of the storage policy

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4nameSSSgvp":{"name":"name","abstract":"

    Name for a storage zone

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StoragePolicy"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC4typeAA0cdeF4TypeOSgvp":{"name":"type","abstract":"

    Type of input

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC9pageIndexSivp":{"name":"pageIndex","abstract":"

    Index of page that the input is on

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC13documentTagIdSSSgvp":{"name":"documentTagId","abstract":"

    This references the ID of a specific tag contained in a file of the sign request

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC9textValueSSSgvp":{"name":"textValue","abstract":"

    Text prefill value

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC13checkboxValueSbSgvp":{"name":"checkboxValue","abstract":"

    Checkbox prefill value

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC9dateValue10Foundation4DateVSgvp":{"name":"dateValue","abstract":"

    Date prefill value

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerDecision.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequestSignerDecision"},"Classes/SignRequestSignerDecision.html#/s:6BoxSDK25SignRequestSignerDecisionC4typeAA0cdeF4TypeOSgvp":{"name":"type","abstract":"

    Type of decision made by the signer

    ","parent_name":"SignRequestSignerDecision"},"Classes/SignRequestSignerDecision.html#/s:6BoxSDK25SignRequestSignerDecisionC11finalizedAt10Foundation4DateVSgvp":{"name":"finalizedAt","abstract":"

    Date and Time that the decision was made

    ","parent_name":"SignRequestSignerDecision"},"Classes/SignRequestSignerDecision.html#/s:6BoxSDK25SignRequestSignerDecisionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestSignerDecision"},"Classes/SignRequestSigner.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC5emailSSvp":{"name":"email","abstract":"

    Email address of the signer

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC4roleAA0cdE4RoleOSgvp":{"name":"role","abstract":"

    Role of the signer

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC10isInPersonSbSgvp":{"name":"isInPerson","abstract":"

    Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC5orderSiSgvp":{"name":"order","abstract":"

    Order of the signer.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC22embedUrlExternalUserIdSSSgvp":{"name":"embedUrlExternalUserId","abstract":"

    User ID for the signer in an external application responsible for authentication when accessing the embed URL.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC17hasViewedDocumentSbSgvp":{"name":"hasViewedDocument","abstract":"

    Flag which indicating if signer has viewed the document.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC14signerDecisionAA0cdeG0CSgvp":{"name":"signerDecision","abstract":"

    Final decision made by the signer.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC6inputsSayAA0cdE5InputCGSgvp":{"name":"inputs","abstract":"

    Inputs created by a signer on a sign request.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC8embedUrlSSSgvp":{"name":"embedUrl","abstract":"

    URL to direct a signer to for signing.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSignFiles.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequestSignFiles"},"Classes/SignRequestSignFiles.html#/s:6BoxSDK011SignRequestC5FilesC5filesSayAA4FileCGSgvp":{"name":"files","abstract":"

    Files that signing events will occur on - these are copies of the original source files.

    ","parent_name":"SignRequestSignFiles"},"Classes/SignRequestSignFiles.html#/s:6BoxSDK011SignRequestC5FilesC18isReadyForDownloadSbSgvp":{"name":"isReadyForDownload","abstract":"

    Indicates whether the signFiles documents are processing and the PDFs may be out of date.","parent_name":"SignRequestSignFiles"},"Classes/SignRequestSignFiles.html#/s:6BoxSDK011SignRequestC5FilesC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestSignFiles"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC08documentF2IdSSSgvp":{"name":"documentTagId","abstract":"

    This references the ID of a specific tag contained in a file of the sign request

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC9textValueSSSgvp":{"name":"textValue","abstract":"

    Text prefill value

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC13checkboxValueSbSgvp":{"name":"checkboxValue","abstract":"

    Checkbox prefill value

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC9dateValue10Foundation4DateVSgvp":{"name":"dateValue","abstract":"

    Date prefill value

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC08documentF2Id9textValueACSSSg_AFtcfc":{"name":"init(documentTagId:textValue:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC08documentF2Id13checkboxValueACSSSg_SbSgtcfc":{"name":"init(documentTagId:checkboxValue:)","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC08documentF2Id9dateValueACSSSg_10Foundation4DateVSgtcfc":{"name":"init(documentTagId:dateValue:)","parent_name":"SignRequestPrefillTag"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC7signersSayAA0cD6SignerCGvp":{"name":"signers","abstract":"

    Signers for the sign request.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC2idSSvp":{"name":"id","abstract":"

    Sign request ID

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC10prepareUrlSSSgvp":{"name":"prepareUrl","abstract":"

    This URL is returned if isDocumentPreparationNeeded is set to true in the request.","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC10signingLogAA4FileCSgvp":{"name":"signingLog","abstract":"

    Reference to a file that holds a log of all signer activity for the request.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC6statusAA0cD6StatusOSgvp":{"name":"status","abstract":"

    Status of the sign request.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC9signFilesAA0cdcF0CSgvp":{"name":"signFiles","abstract":"

    List of files that will be signed, which are copies of the original source files.","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC12autoExpireAt10Foundation4DateVSgvp":{"name":"autoExpireAt","abstract":"

    Uses daysValid to calculate the date and time, the sign request will expire if unsigned.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC27isDocumentPreparationNeededSbSgvp":{"name":"isDocumentPreparationNeeded","abstract":"

    Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC24areTextSignaturesEnabledSbSgvp":{"name":"areTextSignaturesEnabled","abstract":"

    Disables the usage of signatures generated by typing (text). Default is true.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC12emailSubjectSSSgvp":{"name":"emailSubject","abstract":"

    Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC12emailMessageSSSgvp":{"name":"emailMessage","abstract":"

    Message to include in sign request email. The field is cleaned through sanitization of specific characters.","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC19areRemindersEnabledSbSgvp":{"name":"areRemindersEnabled","abstract":"

    Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC11sourceFilesSayAA4FileCGvp":{"name":"sourceFiles","abstract":"

    List of files to create a signing document from.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC12parentFolderAA0F0Cvp":{"name":"parentFolder","abstract":"

    The destination folder to place final, signed document and signing log.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC11prefillTagsSayAA0cD10PrefillTagCGSgvp":{"name":"prefillTags","abstract":"

    List of prefill tags.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC9daysValidSiSgvp":{"name":"daysValid","abstract":"

    Number of days after which this request will automatically expire if not completed.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC10externalIdSSSgvp":{"name":"externalId","abstract":"

    A reference ID in an external system that the sign request is related to.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequest"},"Classes/SharedLink/Permissions.html#/s:6BoxSDK10SharedLinkC11PermissionsV10canPreviewSbSgvp":{"name":"canPreview","abstract":"

    Whether the shared link allows previewing. For shared links on folders, this also applies to any items in the folder.

    ","parent_name":"Permissions"},"Classes/SharedLink/Permissions.html#/s:6BoxSDK10SharedLinkC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Whether the shared link allows downloads. For shared links on folders, this also applies to any items in the folder.

    ","parent_name":"Permissions"},"Classes/SharedLink/Permissions.html":{"name":"Permissions","abstract":"

    Permission for a user accessing item by shared link

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    The URL to access the item on Box. If entered in a browser, this URL will display the item in Box’s preview UI.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC11downloadURL10Foundation0F0VSgvp":{"name":"downloadURL","abstract":"

    The “direct Link” URL to download the item. If entered in a browser, this URL will trigger a download of the item.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC9vanityURL10Foundation0F0VSgvp":{"name":"vanityURL","abstract":"

    The “Custom URL” that can also be used to preview the item on Box.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC15effectiveAccessSSSgvp":{"name":"effectiveAccess","abstract":"

    The effective access level for the shared link. This can be lower than the value in the access field","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC19effectivePermissionSSSgvp":{"name":"effectivePermission","abstract":"

    Actual permissions that are allowed by the shared link, taking into account enterprise and user settings.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC17isPasswordEnabledSbSgvp":{"name":"isPasswordEnabled","abstract":"

    Whether the shared link has a password set.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC10unsharedAt10Foundation4DateVSgvp":{"name":"unsharedAt","abstract":"

    The date-time that this link will become disabled. This field can only be set by users with paid accounts.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC13downloadCountSiSgvp":{"name":"downloadCount","abstract":"

    The number of times the item has been downloaded.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC12previewCountSiSgvp":{"name":"previewCount","abstract":"

    The number of times the item has been previewed.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC6accessAA0cD6AccessOSgvp":{"name":"access","abstract":"

    The access level specified when the shared link was created.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Permissions for download and preview of the item.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SharedLink"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"SharedItemType"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"SharedItemType"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO7webLinkyAeA03WebG0CcAEmF":{"name":"webLink(_:)","abstract":"

    Web link type

    ","parent_name":"SharedItemType"},"Classes/SharedItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SharedItem"},"Classes/SharedItem/SharedItemType.html":{"name":"SharedItemType","abstract":"

    Type of shared item

    ","parent_name":"SharedItem"},"Classes/SharedItem.html#/s:6BoxSDK10SharedItemC9itemValueAC0cD4TypeOvp":{"name":"itemValue","abstract":"

    Shared item value

    ","parent_name":"SharedItem"},"Classes/SharedItem.html#/s:6BoxSDK10SharedItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SharedItem"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC23accessibleViaSharedLink10Foundation3URLVSgvp":{"name":"accessibleViaSharedLink","abstract":"

    The optional shared link through which the user has access to this item.","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4itemAA10FolderItemOvp":{"name":"item","abstract":"

    The file, folder or web link that matched the search query.

    ","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SearchResult"},"Classes/Scope.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC5scopeSSSgvp":{"name":"scope","abstract":"

    Scope permission

    ","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC6objectAA4FileCSgvp":{"name":"object","abstract":"

    The file scope is applied to

    ","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Scope"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC4nameSSSgvp":{"name":"name","abstract":"

    The name of the retention policy.

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC2idSSSgvp":{"name":"id","abstract":"

    ID of the content that is under retention.","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC4typeAA0cdeF4TypeOSgvp":{"name":"type","abstract":"

    Type of the content that is under retention.

    ","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC09retentionD0AA0cD0CSgvp":{"name":"retentionPolicy","abstract":"

    A mini retention policy object representing the retention policy that has been assigned to this content.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedToAA0cdE4ItemCSgvp":{"name":"assignedTo","abstract":"

    Content that is under retention. The type can either be folder or enterprise.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    A mini user object representing the user that created the retention policy assignment object.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    When the retention policy assignment object was created.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC12filterFieldsSayAA19MetadataFieldFilterVGSgvp":{"name":"filterFields","abstract":"

    The array of metadata field filters, if present

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC4nameSSSgvp":{"name":"name","abstract":"

    The name of the retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC10policyTypeAA0cdF0OSgvp":{"name":"policyType","abstract":"

    The type of the retention policy based on whether the amount of time to retain content is known or unknown.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC15retentionLengthSiSgvp":{"name":"retentionLength","abstract":"

    The length of the retention policy. This length specifies the duration in days that the retention policy will be active","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC17dispositionActionAA011DispositionF0OSgvp":{"name":"dispositionAction","abstract":"

    The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC6statusAA0cD6StatusOSgvp":{"name":"status","abstract":"

    The status of the retention policy. Can be either active or retired. Once a policy has been retired, it cannot become active again.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    A mini user object representing the user that created the retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the retention policy object was created.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the retention policy object was last modified.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC014canOwnerExtendC0SbSgvp":{"name":"canOwnerExtendRetention","abstract":"

    Wheter owner can extend time of retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC17areOwnersNotifiedSbSgvp":{"name":"areOwnersNotified","abstract":"

    Whether owners are notified about retention policy changes.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC28customNotificationRecipientsSayAA4UserCGSgvp":{"name":"customNotificationRecipients","abstract":"

    Other users notified about retention policy changes.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicy"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11itemPreviewyA2EmF":{"name":"itemPreview","abstract":"

    Item was previewd

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO10itemUploadyA2EmF":{"name":"itemUpload","abstract":"

    Item was uploaded

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11itemCommentyA2EmF":{"name":"itemComment","abstract":"

    Item was commented on

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO8itemOpenyA2EmF":{"name":"itemOpen","abstract":"

    Item was opened

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO10itemModifyyA2EmF":{"name":"itemModify","abstract":"

    Item was modified

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html":{"name":"InteractionType","abstract":"

    Interaction type with item

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC15interactionTypeAC011InteractionF0Ovp":{"name":"interactionType","abstract":"

    Type of interation

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC12interactedAt10Foundation4DateVvp":{"name":"interactedAt","abstract":"

    Timestamp of the interactions

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4itemAA4FileCvp":{"name":"item","abstract":"

    The item

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC21interactionSharedLinkSSSgvp":{"name":"interactionSharedLink","abstract":"

    Shared link of interaction

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"RecentItem"},"Classes/PollingURLInfo.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC3url10Foundation3URLVvp":{"name":"url","abstract":"

    URL value for checking for new events.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC16timeoutInSecondsSivp":{"name":"timeoutInSeconds","abstract":"

    Timeout in seconds after which request for new changes should be repeated.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC10maxRetriesSSvp":{"name":"maxRetries","abstract":"

    Maximum number of retries in case of failed request for new changes.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PollingURLInfo"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    Box item type

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7versionSivp":{"name":"version","abstract":"

    Version

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7messageAA21EventObserverResponseOvp":{"name":"message","abstract":"

    Message specifying type of the response.

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PollingResult"},"Classes/PathCollection.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of entries in a path

    ","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC7entriesSayAA6FolderCGSgvp":{"name":"entries","abstract":"

    Entries (folders) in a path to an item

    ","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PathCollection"},"Classes/MetadataTemplate.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC2idSSSgvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC11templateKeySSSgvp":{"name":"templateKey","abstract":"

    A unique identifier for the template. The identifier must be unique across the scope of the enterprise to which the metadata template is being applied.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC5scopeSSSgvp":{"name":"scope","abstract":"

    The scope of the object. Global and enterprise scopes are supported.","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC11displayNameSSSgvp":{"name":"displayName","abstract":"

    The display name of the template.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC6hiddenSbSgvp":{"name":"hidden","abstract":"

    Whether this template is hidden in the UI.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC22copyInstanceOnItemCopySbSgvp":{"name":"copyInstanceOnItemCopy","abstract":"

    Whether or not to copy any metadata attached to a file or folder when it is copied. By default, metadata is not copied along with a file or folder when it is copied.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC6fieldsSayAA0C5FieldVGSgvp":{"name":"fields","abstract":"

    The ordered set of key:value pairs for the template.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataObject.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC2idSSSgvp":{"name":"id","abstract":"

    Identifier.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC8templateSSSgvp":{"name":"template","abstract":"

    The key of the template.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC5scopeSSSgvp":{"name":"scope","abstract":"

    The scope of the object. global and enterprise scopes are supported. The global scope contains the properties template,","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC6parentSSSgvp":{"name":"parent","abstract":"

    The ID of the object the metadata object belongs to. Both file and folder objects are supported.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC7versionSiSgvp":{"name":"version","abstract":"

    The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4typeSSSgvp":{"name":"type","abstract":"

    A unique identifier for the “type” of this instance.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC11typeVersionSiSgvp":{"name":"typeVersion","abstract":"

    The last-known version of the template of the object.","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4keysSDySSypGvp":{"name":"keys","abstract":"

    Custom value(s) defined by the template. These values also have a corresponding display name","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataObject"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC4typeSSvp":{"name":"type","abstract":"

    Object type.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC2idSSvp":{"name":"id","abstract":"

    Identifier.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC15ownerEnterpriseAA0G0CSgvp":{"name":"ownerEnterprise","abstract":"

    The enterprise that owns the policy.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    Represent the parent of the policy and the metadata instance to cascade down.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC5scopeAA0C5ScopeOSgvp":{"name":"scope","abstract":"

    The scope of the target instance that will be cascaded down. The scope & templateKey together identify","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC11templateKeySSSgvp":{"name":"templateKey","abstract":"

    The template key of the target metadata template to cascade down. The scope & templateKey together identify","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataCascadePolicy"},"Classes/Lock.html#/s:6BoxSDK4LockC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    Who created the lock.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When was lock created.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When lock expires.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC19isDownloadPreventedSbSgvp":{"name":"isDownloadPrevented","abstract":"

    Whether or not the file can be downloaded while locked.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Lock"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    FIle type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO11fileVersionyAeA04FileJ0CcAEmF":{"name":"fileVersion(_:)","abstract":"

    File version type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html":{"name":"AssignmentItemType","abstract":"

    Type of item legal hold policy was assigned to

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC9itemValueAC0fG4TypeOvp":{"name":"itemValue","abstract":"

    Item that the legal hold policy is assigned to

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC05legaldE0AA0cdE0CSgvp":{"name":"legalHoldPolicy","abstract":"

    The policy that the legal hold policy assignment is part of.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedToAA0cdeF4ItemCSgvp":{"name":"assignedTo","abstract":"

    The entity that the legal hold policy assignment is assigned to.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    The user who created the legal hold policy assignment.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    When the legal hold policy assignment object was created.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    When the assignment release request was sent.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO6activeyA2EmF":{"name":"active","abstract":"

    The policy is not in a transition state

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO8applyingyA2EmF":{"name":"applying","abstract":"

    That the policy is in the process of being applied

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO9releasingyA2EmF":{"name":"releasing","abstract":"

    That the process is in the process of being released

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO8releasedyA2EmF":{"name":"released","abstract":"

    The policy is no longer active

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"Status"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV4userSivp":{"name":"user","abstract":"

    Number of assigned users

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV6folderSivp":{"name":"folder","abstract":"

    Number of assigned folders

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV4fileSivp":{"name":"file","abstract":"

    Number of assigned files

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV11fileVersionSivp":{"name":"fileVersion","abstract":"

    Number of assigned file verions

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html":{"name":"AssignmentCounts","abstract":"

    Counts of the assignments to different entities of this policy

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy/Status.html":{"name":"Status","abstract":"

    Status of legal hold policy

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC10policyNameSSSgvp":{"name":"policyName","abstract":"

    Name of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC11descriptionSSSgvp":{"name":"description","abstract":"

    Description of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC6statusAC6StatusOSgvp":{"name":"status","abstract":"

    Status of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC16assignmentCountsAC010AssignmentG0VSgvp":{"name":"assignmentCounts","abstract":"

    Counts of assignments within this policy by apply-to type.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the legal hold policy object.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the legal hold policy object was created.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the legal hold policy object was modified.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    When the policy release request was sent.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC15filterStartedAt10Foundation4DateVSgvp":{"name":"filterStartedAt","abstract":"

    User-specified, optional date filter applies to Custodian assignments only.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC13filterEndedAt10Foundation4DateVSgvp":{"name":"filterEndedAt","abstract":"

    User-specified, optional date filter applies to Custodian assignments only.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC12releaseNotesSSSgvp":{"name":"releaseNotes","abstract":"

    Notes about why the policy was released.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicy"},"Classes/Invite.html#/s:6BoxSDK6InviteC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9invitedToAA10EnterpriseCSgvp":{"name":"invitedTo","abstract":"

    Enterprise object user is invited to.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC12actionableByAA4UserCSgvp":{"name":"actionableBy","abstract":"

    The user who was invited to the enterprise

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9invitedByAA4UserCSgvp":{"name":"invitedBy","abstract":"

    User who created the invitation.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC6statusSSSgvp":{"name":"status","abstract":"

    Invitation status

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When invitation was created.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When invitation was updated.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Invite"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV13canRunReportsSbvp":{"name":"canRunReports","abstract":"

    Group can run reports

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV15canInstantLoginSbvp":{"name":"canInstantLogin","abstract":"

    Group can login instantly

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV17canCreateAccountsSbvp":{"name":"canCreateAccounts","abstract":"

    Group can create accounts

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV15canEditAccountsSbvp":{"name":"canEditAccounts","abstract":"

    Group can edit accounts

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html":{"name":"ConfigurablePermissions","abstract":"

    Permissions of group membership

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC2idSSvp":{"name":"id","abstract":"

    The ID of the association between a user and a group.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4userAA4UserCSgvp":{"name":"user","abstract":"

    A user object associated with the group.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC5groupAA0C0CSgvp":{"name":"group","abstract":"

    The group the user is associated with.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4roleAA0C4RoleOSgvp":{"name":"role","abstract":"

    The role of the user within the group. The default is member with an option for admin.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC23configurablePermissionsAC012ConfigurableF0VSgvp":{"name":"configurablePermissions","abstract":"

    Permissions of an individual group member.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date time this membership was created at.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date time this membership was modified at.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"GroupMembership"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO07managedC0yA2EmF":{"name":"managedGroup","abstract":"

    Group is managed by the Enterprise admin

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO08allUsersC0yA2EmF":{"name":"allUsersGroup","abstract":"

    A Box-defined group that includes all users in an Enterprise

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this SDK.

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"GroupType"},"Classes/Group/GroupType.html":{"name":"GroupType","abstract":"

    The type of the group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC2idSSvp":{"name":"id","abstract":"

    The ID of the group object.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4nameSSSgvp":{"name":"name","abstract":"

    The name of the group

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC9groupTypeAC0cE0OSgvp":{"name":"groupType","abstract":"

    The type of the group

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the group object was created.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the group object was last modified.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC10provenanceSSSgvp":{"name":"provenance","abstract":"

    Keeps track of which external source this group is coming.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC11descriptionSSSgvp":{"name":"description","abstract":"

    Human readable description of the group. This can be up to 255 characters long

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC22externalSyncIdentifierSSSgvp":{"name":"externalSyncIdentifier","abstract":"

    An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC17invitabilityLevelAA0c12InvitabilityE0OSgvp":{"name":"invitabilityLevel","abstract":"

    Specifies who can invite the group to collaborate on folders.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC22memberViewabilityLevelAA0c6MembereF0OSgvp":{"name":"memberViewabilityLevel","abstract":"

    Specifies who can view the members of the group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Group"},"Classes/FolderUploadEmail.html#/s:6BoxSDK17FolderUploadEmailC6accessSSSgvp":{"name":"access","abstract":"

    Access level

    ","parent_name":"FolderUploadEmail"},"Classes/FolderUploadEmail.html#/s:6BoxSDK17FolderUploadEmailC5emailSSSgvp":{"name":"email","abstract":"

    Email addresss

    ","parent_name":"FolderUploadEmail"},"Classes/FolderLock/LockedOperations.html#/s:6BoxSDK10FolderLockC16LockedOperationsV6deleteSbSgvp":{"name":"delete","abstract":"

    Whether deleting the folder is restricted.

    ","parent_name":"LockedOperations"},"Classes/FolderLock/LockedOperations.html#/s:6BoxSDK10FolderLockC16LockedOperationsV4moveSbSgvp":{"name":"move","abstract":"

    Whether moving the folder is restricted.

    ","parent_name":"LockedOperations"},"Classes/FolderLock/LockedOperations.html":{"name":"LockedOperations","abstract":"

    Locked operations on the folder

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user or group that created the lock.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the folder lock object was created.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC6folderAA0C0CSgvp":{"name":"folder","abstract":"

    The (mini) folder object that the lock applies to.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC8lockTypeSSSgvp":{"name":"lockType","abstract":"

    The lock type, value is always “freeze”.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC16lockedOperationsAC06LockedF0VSgvp":{"name":"lockedOperations","abstract":"

    The operations that have been locked.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FolderLock"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Download permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canUploadSbSgvp":{"name":"canUpload","abstract":"

    Upload permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Rename permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Delete permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Share permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV21canInviteCollaboratorSbSgvp":{"name":"canInviteCollaborator","abstract":"

    Permission to add collaborators

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Permission to set shared link access level for the folder

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html":{"name":"Permissions","abstract":"

    An object containing the permissions that the current user has on this file.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this folder. Used with If-Match headers.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4nameSSSgvp":{"name":"name","abstract":"

    The name of the folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time the folder was created.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this folder was last updated on the Box servers.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the folder. The limit is 256 characters.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC37isCollaborationRestrictedToEnterpriseSbSgvp":{"name":"isCollaborationRestrictedToEnterprise","abstract":"

    Whether future collaborations should be restricted to within the enterprise only

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4sizeSiSgvp":{"name":"size","abstract":"

    The folder size in bytes.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC14pathCollectionAA04PathE0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this folder, starting at the root.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last modified this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10sharedLinkAA06SharedE0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this file. Is nil if no shared link has been created.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17folderUploadEmailAA0ceF0CSgvp":{"name":"folderUploadEmail","abstract":"

    The upload email address for this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC6parentACSgvp":{"name":"parent","abstract":"

    The folder that contains this folder. May be nil for folders such as root, trash and child folders whose parent is inaccessible.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10itemStatusAA04ItemE0OSgvp":{"name":"itemStatus","abstract":"

    Whether this item is deleted or not.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC16contentCreatedAt10Foundation4DateVSgvp":{"name":"contentCreatedAt","abstract":"

    The time the folder or its contents were originally created (according to the uploader). May be nil for some folders such as root or trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17contentModifiedAt10Foundation4DateVSgvp":{"name":"contentModifiedAt","abstract":"

    The time the folder or its contents were last modified (according to the uploader). May be nil for some folders such as root or trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC18canNonOwnersInviteSbSgvp":{"name":"canNonOwnersInvite","abstract":"

    Whether non-owners can invite collaborators to this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    The time the folder or its contents were put in the trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    The time the folder or its contents will be purged from the trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9syncStateAA04SyncE0OSgvp":{"name":"syncState","abstract":"

    Whether this folder will be synced by the Box sync clients or not.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17hasCollaborationsSbSgvp":{"name":"hasCollaborations","abstract":"

    Whether this folder has any collaborators.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    An object containing the permissions that the current user has on this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4tagsSaySSGSgvp":{"name":"tags","abstract":"

    All tags applied to this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC29allowedSharedLinkAccessLevelsSayAA0efG0OGSgvp":{"name":"allowedSharedLinkAccessLevels","abstract":"

    Access level settings for shared links set by administrator.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC19allowedInviteeRolesSaySSGSgvp":{"name":"allowedInviteeRoles","abstract":"

    Folder collaboration roles allowed by the enterprise administrator.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17isExternallyOwnedSbSgvp":{"name":"isExternallyOwned","abstract":"

    Whether this folder is owned by a user outside of the enterprise.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11collectionsSaySDyS2SGGSgvp":{"name":"collections","abstract":"

    The collections the folder belongs to

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC14classificationAA14ClassificationCSgvp":{"name":"classification","abstract":"

    Details about the classification applied to a Box folder

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Folder"},"Classes/FileVersionRetention.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC04fileD0AA0cD0CSgvp":{"name":"fileVersion","abstract":"

    The file version this file version retention was applied to.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4fileAA0C0CSgvp":{"name":"file","abstract":"

    The file this file version retention was applied to.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC9appliedAt10Foundation4DateVSgvp":{"name":"appliedAt","abstract":"

    When this file version retention object was created.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC13dispositionAt10Foundation4DateVSgvp":{"name":"dispositionAt","abstract":"

    When the retention period expires on this file version retention.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC07winningE6PolicyAA0eG0CSgvp":{"name":"winningRetentionPolicy","abstract":"

    The winning retention policy applied to this file version retention. A file version can have multiple retention policies applied.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC2idSSvp":{"name":"id","abstract":"

    The ID of the file version legal hold object.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC04fileD0AA0cD0CSgvp":{"name":"fileVersion","abstract":"

    The file version that is held

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4fileAA0C0CSgvp":{"name":"file","abstract":"

    The parent file of the file version that is held.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC05legalF17PolicyAssignmentsSayAA0efH10AssignmentCGSgvp":{"name":"legalHoldPolicyAssignments","abstract":"

    List of assignments contributing to this hold.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    Time that this file version legal hold was deleted.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC2idSSvp":{"name":"id","abstract":"

    The ID of the file version object

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4sha1SSSgvp":{"name":"sha1","abstract":"

    The SHA-1 hash of the file.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4nameSSSgvp":{"name":"name","abstract":"

    The name of the file version

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4sizes5Int64VSgvp":{"name":"size","abstract":"

    Size of the file version in bytes

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC19uploaderDisplayNameSSSgvp":{"name":"uploaderDisplayName","abstract":"

    User’s name at the time of upload

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the file version object was created

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the file version object was last updated

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last updated the file version

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When the file version object was trashed.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9trashedByAA4UserCSgvp":{"name":"trashedBy","abstract":"

    The user who trashed the file version.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When the file version object was purged.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10restoredAt10Foundation4DateVSgvp":{"name":"restoredAt","abstract":"

    When the file version object was restored.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10restoredByAA4UserCSgvp":{"name":"restoredBy","abstract":"

    The user who restored the file version.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersion"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Permission for download

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV10canPreviewSbSgvp":{"name":"canPreview","abstract":"

    Permission for preview

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canUploadSbSgvp":{"name":"canUpload","abstract":"

    Permission for upload

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV10canCommentSbSgvp":{"name":"canComment","abstract":"

    Permission to comment

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Permission to rename

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Permission to delete

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Permission to share

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Permission to share access

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV21canInviteCollaboratorSbSgvp":{"name":"canInviteCollaborator","abstract":"

    Permission to invite collaborators

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV11canAnnotateSbSgvp":{"name":"canAnnotate","abstract":"

    Permission to annotate

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV21canViewAnnotationsAllSbSgvp":{"name":"canViewAnnotationsAll","abstract":"

    Permission to view all annotations

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV22canViewAnnotationsSelfSbSgvp":{"name":"canViewAnnotationsSelf","abstract":"

    Permission to view signed in user annotations

    ","parent_name":"Permissions"},"Classes/File/Permissions.html":{"name":"Permissions","abstract":"

    Permissions that the current user has on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11fileVersionAA0cE0CSgvp":{"name":"fileVersion","abstract":"

    The version information of the file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this file object.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4sha1SSSgvp":{"name":"sha1","abstract":"

    The SHA-1 hash of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4nameSSSgvp":{"name":"name","abstract":"

    The name of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9extensionSSSgvp":{"name":"extension","abstract":"

    Indicates the suffix, when available, on the file. By default, set to an empty string.","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11descriptionSSSgvp":{"name":"description","abstract":"

    The description of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4sizeSiSgvp":{"name":"size","abstract":"

    Size of this file in bytes.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC14pathCollectionAA04PathE0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this item, starting at the root.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC12commentCountSiSgvp":{"name":"commentCount","abstract":"

    Description

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The number of comments on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this file was last updated on the Box servers.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When this file was moved to the trash.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When this file will be permanently deleted.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC16contentCreatedAt10Foundation4DateVSgvp":{"name":"contentCreatedAt","abstract":"

    When the content of this file was created.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17contentModifiedAt10Foundation4DateVSgvp":{"name":"contentModifiedAt","abstract":"

    When the content of this file was last modified.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9isPackageSbSgvp":{"name":"isPackage","abstract":"

    Whether the file is a package. Used for Mac Packages used by iWorks.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC19uploaderDisplayNameSSSgvp":{"name":"uploaderDisplayName","abstract":"

    User’s name at the time of upload

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who first created this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last updated this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10sharedLinkAA06SharedE0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    The folder containing this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10itemStatusAA04ItemE0OSgvp":{"name":"itemStatus","abstract":"

    Whether this item is deleted or not. Values include active, trashed if the file has been moved to the trash,","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC13versionNumberSSSgvp":{"name":"versionNumber","abstract":"

    The version number of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When the file will automatically be deleted, i.e. expired.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Permissions that the current user has on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17expiringEmbedLinkAA08ExpiringeF0CSgvp":{"name":"expiringEmbedLink","abstract":"

    An expiring URL for an embedded preview session in an iframe. This URL will expire after 60 seconds and the session will expire after 60 minutes.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11collectionsSaySDyS2SGGSgvp":{"name":"collections","abstract":"

    The collections that the file belongs to

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4lockAA4LockCSgvp":{"name":"lock","abstract":"

    The lock held on this file. If there is no lock, this can either be null or have a timestamp in the past.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4tagsSaySSGSgvp":{"name":"tags","abstract":"

    All tags applied to this file

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17hasCollaborationsSbSgvp":{"name":"hasCollaborations","abstract":"

    Whether this file has any collaborators.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17isExternallyOwnedSbSgvp":{"name":"isExternallyOwned","abstract":"

    Whether this file is owned by a user outside of the enterprise.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC19allowedInviteeRolesSayAA17CollaborationRoleOGSgvp":{"name":"allowedInviteeRoles","abstract":"

    File collaboration roles allowed by the enterprise administrator.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC15representationsAA24EntryContainerInnerModelCyAA0C14RepresentationVGSgvp":{"name":"representations","abstract":"

    Digital assets created for this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC14classificationAA14ClassificationCSgvp":{"name":"classification","abstract":"

    Details about the classification applied to a Box file

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"File"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    Embed link URL

    ","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC5tokenAA5TokenCSgvp":{"name":"token","abstract":"

    Information about the token used by the embed component

    ","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ExpiringEmbedLink"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO7commentyAeA7CommentCcAEmF":{"name":"comment(_:)","abstract":"

    Comment type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO7unknownyA2EmF":{"name":"unknown","abstract":"

    Unknown type

    ","parent_name":"EventItemType"},"Classes/EventItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EventItem"},"Classes/EventItem/EventItemType.html":{"name":"EventItemType","abstract":"

    Type of the object modified by the event

    ","parent_name":"EventItem"},"Classes/EventItem.html#/s:6BoxSDK9EventItemC9itemValueAC0cD4TypeOvp":{"name":"itemValue","abstract":"

    Event item type

    ","parent_name":"EventItem"},"Classes/EventItem.html#/s:6BoxSDK9EventItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EventItem"},"Classes/EventContainer.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of events

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC7entriesSayAA0C0CGSgvp":{"name":"entries","abstract":"

    Events in a container

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC5limitSiSgvp":{"name":"limit","abstract":"

    Maximum number of events per page

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC18nextStreamPositionSSSgvp":{"name":"nextStreamPosition","abstract":"

    Defines next stream position in the stream

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC9chunkSizeSiSgvp":{"name":"chunkSize","abstract":"

    The number of event records contained in the object with entries.

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EventContainer"},"Classes/Event.html#/s:6BoxSDK5EventC4typeSSvp":{"name":"type","abstract":"

    Box event object type

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user that performed the action represented by the event. Some events may be performed by users not logged into Box.","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9eventTypeAA0cE0Ovp":{"name":"eventType","abstract":"

    One of the event types.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9sessionIdSSSgvp":{"name":"sessionId","abstract":"

    The session ID of the user who performed the action represented by the event.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC6sourceAA0C4ItemCSgvp":{"name":"source","abstract":"

    The object associated with the event.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the event occurred (when the user performed the action).

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC10recordedAt10Foundation4DateVSgvp":{"name":"recordedAt","abstract":"

    When the event was stored in the Box database.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC17additionalDetailsSDySSypGSgvp":{"name":"additionalDetails","abstract":"

    Additional details for the event

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Event"},"Classes/EntryContainerInnerModel.html#/s:6BoxSDK24EntryContainerInnerModelC7entriesSayxGSgvp":{"name":"entries","abstract":"

    Container entries

    ","parent_name":"EntryContainerInnerModel"},"Classes/Order.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC2bySSSgvp":{"name":"by","abstract":"

    Defines which parameters are items ordered by

    ","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC9directionAA0C9DirectionOSgvp":{"name":"direction","abstract":"

    Defines direction of items order - ascending or descending

    ","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Order"},"Classes/EntryContainer.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of entries

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC7entriesSayxGvp":{"name":"entries","abstract":"

    Entries in a container

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC6offsetSiSgvp":{"name":"offset","abstract":"

    Paging offset

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC10nextMarkerSSSgvp":{"name":"nextMarker","abstract":"

    Next paging marker value

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC18nextStreamPositionSSSgvp":{"name":"nextStreamPosition","abstract":"

    Next stream position

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC5limitSiSgvp":{"name":"limit","abstract":"

    Maximum number of items per page

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC5orderSayAA5OrderCGSgvp":{"name":"order","abstract":"

    Defines how entries are ordered

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC4jsonACyxGSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EntryContainer"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4typeSSvp":{"name":"type","abstract":"

    Type of Box item.

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4nameSSSgvp":{"name":"name","abstract":"

    Enterprise name

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Enterprise"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC4typeSSvp":{"name":"type","abstract":"

    Type of Box item.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC11isConfirmedSbSgvp":{"name":"isConfirmed","abstract":"

    Whether email alias is confirmed.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC5emailSSSgvp":{"name":"email","abstract":"

    User’s email address.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EmailAlias"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC2idSSvp":{"name":"id","abstract":"

    The ID of the device pinner object.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user that the device pin belongs to.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC11productNameSSSgvp":{"name":"productName","abstract":"

    The type of device being pinned.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time the device pin was created.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time the device pin was modified.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"DevicePin"},"Classes/Comment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC07isReplyC0SbSgvp":{"name":"isReplyComment","abstract":"

    Whether or not this comment is a reply to another comment.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC7messageSSSgvp":{"name":"message","abstract":"

    The comment text that the user typed.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC13taggedMessageSSSgvp":{"name":"taggedMessage","abstract":"

    The string representing the comment text with @mentions included. @mention format is @[id:username]","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    A mini user object representing the author of the comment.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time this comment was created.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The object this comment was placed on.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time this comment was last modified

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Comment"},"Classes/Collaborator/CollaboratorType.html#/s:6BoxSDK12CollaboratorC0C4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"CollaboratorType"},"Classes/Collaborator/CollaboratorType.html#/s:6BoxSDK12CollaboratorC0C4TypeO5groupyAeA5GroupCcAEmF":{"name":"group(_:)","abstract":"

    Group type

    ","parent_name":"CollaboratorType"},"Classes/Collaborator.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Collaborator"},"Classes/Collaborator/CollaboratorType.html":{"name":"CollaboratorType","abstract":"

    Type of collaborator

    ","parent_name":"Collaborator"},"Classes/Collaborator.html#/s:6BoxSDK12CollaboratorC17collaboratorValueAC0C4TypeOvp":{"name":"collaboratorValue","abstract":"

    Type of collaborator

    ","parent_name":"Collaborator"},"Classes/Collaborator.html#/s:6BoxSDK12CollaboratorC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Collaborator"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4userAA4UserCSgvp":{"name":"user","abstract":"

    The user that is exempted from the collaboration allowlist

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the enterprise.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the target object was created.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the target object was last modified.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC6domainSSSgvp":{"name":"domain","abstract":"

    The URL domain name

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC9directionAA0C9DirectionOSgvp":{"name":"direction","abstract":"

    Direction of colaboration - can be inbound, outbound or both

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the user’s enterprise.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the collaboration object was created.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the collaboration object was last modified.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC013enterpriseHasdE11AuthEnabledSbvp":{"name":"enterpriseHasTwoFactorAuthEnabled","abstract":"

    Indicator for whether the enterpise has two factor authentication enabled.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC07userHasdeF7EnabledSbvp":{"name":"userHasTwoFactorAuthenticationEnabled","abstract":"

    Indicator for whether the user has two factor authentication enabled.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC06strongE24RequiredForExternalUsersSbvp":{"name":"strongPasswordRequiredForExternalUsers","abstract":"

    Indicator for whether the current enterprise has strong password enabled for users external","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC07userHasdE0Sbvp":{"name":"userHasStrongPassword","abstract":"

    Indicator for whether the user has strong password enabled.

    ","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC10isAcceptedSbvp":{"name":"isAccepted","abstract":"

    Indicator for whether or not the Terms of Service has been accepted.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC05termseF0AA0deF0Cvp":{"name":"termsOfService","abstract":"

    The Terms of Service associated with the requirement status.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC25termsOfServiceRequirementAC05TermshiJ0Cvp":{"name":"termsOfServiceRequirement","abstract":"

    The requirements for Terms of Service part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC25strongPasswordRequirementAC06StronghI0Cvp":{"name":"strongPasswordRequirement","abstract":"

    The requirements for Strong Password part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC34twoFactorAuthenticationRequirementAC03TwohiJ0Cvp":{"name":"twoFactorAuthenticationRequirement","abstract":"

    The requirements for Two Factor Authentication part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the collaboration object.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the collaboration object was created.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the collaboration object was last modified.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When the collaboration will expire.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC6statusAA0C6StatusOSgvp":{"name":"status","abstract":"

    The status of the collaboration invitation.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC12accessibleByAA12CollaboratorCSgvp":{"name":"accessibleBy","abstract":"

    The user or group that is granted access.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4roleAA0C4RoleOSgvp":{"name":"role","abstract":"

    The level of access granted.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC14acknowledgedAt10Foundation4DateVSgvp":{"name":"acknowledgedAt","abstract":"

    When the status of the collaboration object changed to accepted or rejected.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The file or folder that access is granted to

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC11inviteEmailSSSgvp":{"name":"inviteEmail","abstract":"

    The email address used to invite an un-registered collaborator, if they are not a registered user.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC11canViewPathSbSgvp":{"name":"canViewPath","abstract":"

    Whether the “view path collaboration” feature is enabled or not.","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC28acceptanceRequirementsStatusAC010AcceptanceeF0CSgvp":{"name":"acceptanceRequirementsStatus","abstract":"

    The acceptance requirements for the user or enterprise.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Collaboration"},"Classes/Collaboration/AcceptanceRequirementsStatus.html":{"name":"AcceptanceRequirementsStatus","abstract":"

    Defines the Acceptance Requirements Status object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/TermsOfServiceRequirement.html":{"name":"TermsOfServiceRequirement","abstract":"

    Defines the Terms of Service requirement for the Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/StrongPasswordRequirement.html":{"name":"StrongPasswordRequirement","abstract":"

    Defines the Strong Password requirement for the Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html":{"name":"TwoFactorAuthenticationRequirement","abstract":"

    Defines the Two Factor Authentication Requirement for Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Classification.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC5colorSo7UIColorCSgvp":{"name":"color","abstract":"

    The color that is used to display the classification label in a user-interface

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC10definitionSSSgvp":{"name":"definition","abstract":"

    An explanation of the meaning of this classification

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC4nameSSSgvp":{"name":"name","abstract":"

    Name of the classification

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Classification"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4typeSSvp":{"name":"type","abstract":"

    Box item type - should be collection.

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4nameSSSgvp":{"name":"name","abstract":"

    Name of the collection

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC14collectionTypeSSSgvp":{"name":"collectionType","abstract":"

    The type of the collection. This is used to determine the proper visual treatment for collections.","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxCollection"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO10jsonObjectyAESDySSypGcAEmF":{"name":"jsonObject(_:)","abstract":"

    JSON body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO9jsonArrayyAESaySDySSypGGcAEmF":{"name":"jsonArray(_:)","abstract":"

    JSON Array body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO14urlencodedFormyAESDyS2SGcAEmF":{"name":"urlencodedForm(_:)","abstract":"

    URL encoded form body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO4datayAE10Foundation4DataVcAEmF":{"name":"data(_:)","abstract":"

    Data body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO9multipartyAeA13MultipartFormVcAEmF":{"name":"multipart(_:)","abstract":"

    Multipart form body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO5emptyyA2EmF":{"name":"empty","abstract":"

    Empty body

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html":{"name":"BodyType","abstract":"

    Defines body type of a request

    ","parent_name":"BoxRequest"},"Classes/PagingIterator.html#/s:6BoxSDK14PagingIteratorC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    The total count of the result set, if known

    ","parent_name":"PagingIterator"},"Classes/PagingIterator.html#/s:6BoxSDK14PagingIteratorC4next10completionyys6ResultOyAA14EntryContainerCyxGAA0A8SDKErrorCGc_tF":{"name":"next(completion:)","abstract":"

    Gets next page of elements from the iterator

    ","parent_name":"PagingIterator"},"Classes/BoxNetworkTask.html#/s:6BoxSDK0A11NetworkTaskC9cancelledSbvp":{"name":"cancelled","abstract":"

    Whether the task is cancelled or not

    ","parent_name":"BoxNetworkTask"},"Classes/BoxNetworkTask.html#/s:6BoxSDK0A11NetworkTaskC6cancelyyF":{"name":"cancel()","abstract":"

    Method to cancel a Box Network Task

    ","parent_name":"BoxNetworkTask"},"Classes/BoxNetworkAgent.html#/s:6BoxSDK0A12NetworkAgentC13configurationAcA0A16SDKConfigurationV_tcfc":{"name":"init(configuration:)","abstract":"

    Initializer.

    ","parent_name":"BoxNetworkAgent"},"Classes/BoxNetworkAgent.html#/s:6BoxSDK0A12NetworkAgentC4send7request10completionyAA0A7RequestC_ys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"send(request:completion:)","abstract":"

    Makes Box SDK request

    ","parent_name":"BoxNetworkAgent"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC4list6marker5limit6fieldsAA14PagingIteratorCyAA7WebhookCGSSSg_SiSgSaySSGSgtF":{"name":"list(marker:limit:fields:)","abstract":"

    Get all webhooks in an enterprise.

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC3get9webhookId6fields10completionySS_SaySSGSgys6ResultOyAA7WebhookCAA0A8SDKErrorCGctF":{"name":"get(webhookId:fields:completion:)","abstract":"

    Get information about a webhook.

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6update9webhookId10targetType0hG08triggers7address6fields10completionySS_SSSgALSayAA7WebhookC13EventTriggersOGSgALSaySSGSgys6ResultOyAnA0A8SDKErrorCGctF":{"name":"update(webhookId:targetType:targetId:triggers:address:fields:completion:)","abstract":"

    Update a webhook

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6create10targetType0F2Id8triggers7address6fields10completionySS_SSSayAA7WebhookC13EventTriggersOGSSSaySSGSgys6ResultOyAlA0A8SDKErrorCGctF":{"name":"create(targetType:targetId:triggers:address:fields:completion:)","abstract":"

    Create a webhook

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6delete9webhookId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(webhookId:completion:)","abstract":"

    Deletes a webhook.

    ","parent_name":"WebhooksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC3get9webLinkId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(webLinkId:fields:completion:)","abstract":"

    Get information about a specified web link.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6create3url8parentId4name11description10sharedLink6fields10completionySS_S2SSgAlA17NullableParameterOyAA06SharedM4DataVGSgSaySSGSgys6ResultOyAA0cM0CAA0A8SDKErrorCGctF":{"name":"create(url:parentId:name:description:sharedLink:fields:completion:)","abstract":"

    Creates a new web link with the specified url on the specified item.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6update9webLinkId3url06parentI04name11description06sharedH06fields10completionySS_SSSgA3mA17NullableParameterOyAA06SharedH4DataVGSgSaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"update(webLinkId:url:parentId:name:description:sharedLink:fields:completion:)","abstract":"

    Update the specified web link info.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6delete9webLinkId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(webLinkId:completion:)","abstract":"

    Delete a specified web link.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC13getSharedLink03forcH010completionySS_ys6ResultOyAA0gH0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forWebLink:completion:)","abstract":"

    Gets web link with updated shared link

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC13setSharedLink03forcH06access10unsharedAt8password11canDownload10completionySS_AA0gH6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0gH0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forWebLink:access:unsharedAt:password:canDownload:completion:)","abstract":"

    Creates or updates shared link for a web link

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC16deleteSharedLink03forcH010completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forWebLink:completion:)","abstract":"

    Removes shared link for a web link

    ","parent_name":"WebLinksModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC10getCurrent6fields10completionySaySSGSg_ys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"getCurrent(fields:completion:)","abstract":"

    Get information about the user for which this client is authenticated.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC3get6userId6fields10completionySS_SaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"get(userId:fields:completion:)","abstract":"

    Get information about a user in the enterprise. Requires enterprise administration","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC9getAvatar6userId10completionySS_ys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF":{"name":"getAvatar(userId:completion:)","abstract":"

    Get image of a user’s avatar

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6create5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0J24ExternalCollabRestricted0J22ExemptFromDeviceLimits0J27ExemptFromLoginVerification6status6fields10completionySS_SSAA8UserRoleOSgSSSgSbSgA3Zs5Int64VSgSayAA4UserC12TrackingCodeVGSgA_AZA_A_A_AA10UserStatusOSgSaySSGSgys6ResultOyA4_AA0A8SDKErrorCGctF":{"name":"create(login:name:role:language:isSyncEnabled:jobTitle:phone:address:spaceAmount:trackingCodes:canSeeManagedUsers:timezone:isExternalCollabRestricted:isExemptFromDeviceLimits:isExemptFromLoginVerification:status:fields:completion:)","abstract":"

    Create a new managed user in an enterprise. This method only works for Box admins.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6update6userId5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0L24ExternalCollabRestricted0L22ExemptFromDeviceLimits0L27ExemptFromLoginVerification6status6fields10completionySS_SSSgAxA8UserRoleOSgAXSbSgA3Xs5Int64VSgSayAA4UserC12TrackingCodeVGSgA0_AXA0_A0_A0_AA10UserStatusOSgSaySSGSgys6ResultOyA5_AA0A8SDKErrorCGctF":{"name":"update(userId:login:name:role:language:isSyncEnabled:jobTitle:phone:address:spaceAmount:trackingCodes:canSeeManagedUsers:timezone:isExternalCollabRestricted:isExemptFromDeviceLimits:isExemptFromLoginVerification:status:fields:completion:)","abstract":"

    Update the information for a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC13createAppUser4name8language8jobTitle8timezone5phone7address11spaceAmount6status26isExternalCollabRestricted013canSeeManagedC06fields10completionySS_SSSgA4Qs5Int64VSgAA0G6StatusOSgSbSgAXSaySSGSgys6ResultOyAA0G0CAA0A8SDKErrorCGctF":{"name":"createAppUser(name:language:jobTitle:timezone:phone:address:spaceAmount:status:isExternalCollabRestricted:canSeeManagedUsers:fields:completion:)","abstract":"

    Create a new app user in an enterprise.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6delete6userId6notify5force10completionySS_SbSgAIys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(userId:notify:force:completion:)","abstract":"

    Delete a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC17listForEnterprise10filterTerm6fields9usemarker6marker6offset5limitAA14PagingIteratorCyAA4UserCGSSSg_SaySSGSgSbSgAPSiSgATtF":{"name":"listForEnterprise(filterTerm:fields:usemarker:marker:offset:limit:)","abstract":"

    Returns all of the users for the Enterprise. Only available to admin accounts or service accounts.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC22inviteToJoinEnterprise5login12enterpriseId6fields10completionySS_SSSaySSGSgys6ResultOyAA6InviteCAA0A8SDKErrorCGctF":{"name":"inviteToJoinEnterprise(login:enterpriseId:fields:completion:)","abstract":"

    Invite an existing user to join an Enterprise.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC20moveItemsOwnedByUser6withID02toi4WithK06notify6fields10completionySS_SSSbSgSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"moveItemsOwnedByUser(withID:toUserWithID:notify:fields:completion:)","abstract":"

    Move all of the items owned by a user into a new folder in another user’s account.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC11changeLogin6userId5login6fields10completionySS_SSSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"changeLogin(userId:login:fields:completion:)","abstract":"

    Used to convert one of the user’s confirmed email aliases into the user’s primary login.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16listEmailAliases6userId10completionySS_ys6ResultOyAA14EntryContainerCyAA0F5AliasCGAA0A8SDKErrorCGctF":{"name":"listEmailAliases(userId:completion:)","abstract":"

    Retrieves all email aliases for this user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16createEmailAlias6userId5email10completionySS_SSys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createEmailAlias(userId:email:completion:)","abstract":"

    Adds a new email alias to the given user’s account.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16deleteEmailAlias6userId05emailgI010completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteEmailAlias(userId:emailAliasId:completion:)","abstract":"

    Removes an email alias from a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC19rollOutOfEnterprise6userId6notify6fields10completionySS_SbSgSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"rollOutOfEnterprise(userId:notify:fields:completion:)","abstract":"

    Roll a user out of their enterprise (and convert them to a standalone free user)

    ","parent_name":"UsersModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC9listItems6offset5limit6fieldsAA14PagingIteratorCyAA10FolderItemOGSiSg_AMSaySSGSgtF":{"name":"listItems(offset:limit:fields:)","abstract":"

    Gets the files, folders and web links that are in the user’s trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC7getFile2id6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getFile(id:fields:completion:)","abstract":"

    Get a file that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC9getFolder2id6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getFolder(id:fields:completion:)","abstract":"

    Get a folder that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC10getWebLink2id6fields10completionySS_SaySSGSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getWebLink(id:fields:completion:)","abstract":"

    Get a web link that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC11restoreFile2id4name14parentFolderId6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"restoreFile(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a file that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC13restoreFolder2id4name06parentF2Id6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"restoreFolder(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a folder that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC14restoreWebLink2id4name14parentFolderId6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"restoreWebLink(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a web link that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC21permanentlyDeleteFile2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteFile(id:completion:)","abstract":"

    Permanently delete a file that is in the trash. The file will no longer exist in Box.","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC23permanentlyDeleteFolder2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteFolder(id:completion:)","abstract":"

    Permanently delete a folder that is in the trash. The folder will no longer exist","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC24permanentlyDeleteWebLink2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteWebLink(id:completion:)","abstract":"

    Permanently delete a web link that is in the trash. The web link will no longer exist","parent_name":"TrashModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6create6status7tosType4text6fields10completionyAA0cD13ServiceStatusO_AA0cdnJ0OSSSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF":{"name":"create(status:tosType:text:fields:completion:)","abstract":"

    Creates a Terms of Service for an enterprise.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6update5tosId4text6status6fields10completionySS_SSAA0cD13ServiceStatusOSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF":{"name":"update(tosId:text:status:fields:completion:)","abstract":"

    Updates a specified Terms of Service.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC3get5tosId6fields10completionySS_SaySSGSgys6ResultOyAA0cD7ServiceCAA0A8SDKErrorCGctF":{"name":"get(tosId:fields:completion:)","abstract":"

    Retrieves a specified Terms of Service.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC17listForEnterprise7tosType6fields10completionyAA0cd7ServiceK0OSg_SaySSGSgys6ResultOySayAA0cdN0CGAA0A8SDKErrorCGctF":{"name":"listForEnterprise(tosType:fields:completion:)","abstract":"

    Retrieves both external and managed Terms of Services if no Terms of Service type is specified.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16createUserStatus5tosId10isAccepted04userK06fields10completionySS_SbSSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"createUserStatus(tosId:isAccepted:userId:fields:completion:)","abstract":"

    Creates an association between a terms of service and a specified user. If no user is specified, defaults to current user.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16updateUserStatus04userI2Id10isAccepted6fields10completionySS_SbSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"updateUserStatus(userStatusId:isAccepted:fields:completion:)","abstract":"

    Update the user status on the Terms of Service. Choose to either accept or deny.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC13getUserStatus5tosId04userK06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"getUserStatus(tosId:userId:fields:completion:)","abstract":"

    Retrieves the user status for the specified Terms of Service and the specified user.

    ","parent_name":"TermsOfServicesModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC3get6taskId6fields10completionySS_SaySSGSgys6ResultOyAA4TaskCAA0A8SDKErrorCGctF":{"name":"get(taskId:fields:completion:)","abstract":"

    Fetches a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6create6fileId6action7message5dueAt14completionRule6fields0L0ySS_AA10TaskActionOSSSg10Foundation4DateVSgAA0o10CompletionM0OSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"create(fileId:action:message:dueAt:completionRule:fields:completion:)","abstract":"

    Used to create a single task for single user on a single file.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6update6taskId6action7message5dueAt14completionRule6fields0L0ySS_AA10TaskActionOSSSg10Foundation4DateVSgAA0o10CompletionM0OSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"update(taskId:action:message:dueAt:completionRule:fields:completion:)","abstract":"

    Updates a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6delete6taskId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(taskId:completion:)","abstract":"

    Permanently deletes a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC13getAssignment04taskF2Id6fields10completionySS_SaySSGSgys6ResultOyAA04TaskF0CAA0A8SDKErrorCGctF":{"name":"getAssignment(taskAssignmentId:fields:completion:)","abstract":"

    Fetches a specific task assignment.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6assign6taskId04userG06fields10completionySS_SSSaySSGSgys6ResultOyAA14TaskAssignmentCAA0A8SDKErrorCGctF":{"name":"assign(taskId:userId:fields:completion:)","abstract":"

    Used to assign a task to a single user identified by userId.","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC13assignByEmail6taskId5email6fields10completionySS_SSSaySSGSgys6ResultOyAA14TaskAssignmentCAA0A8SDKErrorCGctF":{"name":"assignByEmail(taskId:email:fields:completion:)","abstract":"

    Used to assign a task to a single user identified by login.","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC16updateAssignment04taskF2Id7message15resolutionState10completionySS_SSSgAA0fK0OSgys6ResultOyAA04TaskF0CAA0A8SDKErrorCGctF":{"name":"updateAssignment(taskAssignmentId:message:resolutionState:completion:)","abstract":"

    Used to update a task assignment.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC16deleteAssignment04taskF2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteAssignment(taskAssignmentId:completion:)","abstract":"

    Permanently deletes a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC15listAssignments9forTaskId10completionySS_ys6ResultOySayAA0H10AssignmentCGAA0A8SDKErrorCGctF":{"name":"listAssignments(forTaskId:completion:)","abstract":"

    Fetches a all task assignments for particular task.

    ","parent_name":"TasksModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC3get15storagePolicyId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(storagePolicyId:fields:completion:)","abstract":"

    Get information about a storage policy.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC17listForEnterprise6marker5limit6fieldsAA14PagingIteratorCyAA0C6PolicyCGSSSg_SiSgSaySSGSgtF":{"name":"listForEnterprise(marker:limit:fields:)","abstract":"

    Get all of the storage policies in an enterprise.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC13getAssignment013storagePolicyG2Id6fields10completionySS_SaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF":{"name":"getAssignment(storagePolicyAssignmentId:fields:completion:)","abstract":"

    Get storage policy assignment information.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC15listAssignments15resolvedForType0hI2Id6fields10completionySS_SSSaySSGSgys6ResultOyAA0C16PolicyAssignmentCAA0A8SDKErrorCGctF":{"name":"listAssignments(resolvedForType:resolvedForId:fields:completion:)","abstract":"

    Get the storage policy assignment assigned to a user or enterprise.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC6assign15storagePolicyId14assignedToType0jkI06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cH10AssignmentCAA0A8SDKErrorCGctF":{"name":"assign(storagePolicyId:assignedToType:assignedToId:fields:completion:)","abstract":"

    Create storage policy assignment.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC11forceAssign15storagePolicyId14assignedToType0klJ06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cI10AssignmentCAA0A8SDKErrorCGctF":{"name":"forceAssign(storagePolicyId:assignedToType:assignedToId:fields:completion:)","abstract":"

    Assign policy

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16updateAssignment013storagePolicyG2Id0hiJ06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF":{"name":"updateAssignment(storagePolicyAssignmentId:storagePolicyId:fields:completion:)","abstract":"

    Update storage policy assignment.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16deleteAssignment013storagePolicyG2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteAssignment(storagePolicyAssignmentId:completion:)","abstract":"

    Deleting a storage policy assignment means the user will inherit the Enterprise’s default storage policy.

    ","parent_name":"StoragePoliciesModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC6create7signers11sourceFiles12parentFolder10parameters10completionySayAA0C19RequestCreateSignerVG_SayAA0cnO10SourceFileVGAA0cno6ParentK0VAA0cnO10ParametersVSgys6ResultOyAA0cN0CAA0A8SDKErrorCGctF":{"name":"create(signers:sourceFiles:parentFolder:parameters:completion:)","abstract":"

    Creates a sign request. This involves preparing a document for signing and sending the sign request to signers.

    ","parent_name":"SignRequestsModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC4list6marker5limitAA14PagingIteratorCyAA0C7RequestCGSSSg_SiSgtF":{"name":"list(marker:limit:)","abstract":"

    List all sign requests.

    ","parent_name":"SignRequestsModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC7getById2id10completionySS_ys6ResultOyAA0C7RequestCAA0A8SDKErrorCGctF":{"name":"getById(id:completion:)","abstract":"

    Get sign request by ID.

    ","parent_name":"SignRequestsModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC10resendById2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"resendById(id:completion:)","abstract":"

    Resends a sign request email to all outstanding signers.","parent_name":"SignRequestsModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC10cancelById2id10completionySS_ys6ResultOyAA0C7RequestCAA0A8SDKErrorCGctF":{"name":"cancelById(id:completion:)","abstract":"

    Cancels a sign request if it has not yet been signed or declined.","parent_name":"SignRequestsModule"},"Classes/SharedItemsModule.html#/s:6BoxSDK17SharedItemsModuleC3get13sharedLinkURL0gH8Password6fields10completionySS_SSSgSaySSGSgys6ResultOyAA0C4ItemCAA0A8SDKErrorCGctF":{"name":"get(sharedLinkURL:sharedLinkPassword:fields:completion:)","abstract":"

    Get the item back from the shared link.

    ","parent_name":"SharedItemsModule"},"Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC5queryAD5scope14fileExtensions12createdAfter0I6Before07updatedJ00lK011sizeAtLeast0mN4Most12ownerUserIDs014ancestorFolderS08searchIn8itemType0V5Trash14metadataFilter6fields6offset5limitAA14PagingIteratorCyAA0U4ItemOGSSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA8_A8_A8_s5Int64VSgA11_A4_A4_SayAA0c7ContentY0OGSgAA0c4ItemY0OSgSbSgAA08MetadataC6FilterCSgA4_SiSgA23_tF":{"name":"query(query:scope:fileExtensions:createdAfter:createdBefore:updatedAfter:updatedBefore:sizeAtLeast:sizeAtMost:ownerUserIDs:ancestorFolderIDs:searchIn:itemType:searchTrash:metadataFilter:fields:offset:limit:)","abstract":"

    Searches for items in Box.

    ","parent_name":"SearchModule"},"Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC20queryWithSharedLinks0E05scope14fileExtensions12createdAfter0L6Before07updatedM00oN011sizeAtLeast0pQ4Most12ownerUserIDs014ancestorFolderV08searchIn8itemType0Y5Trash14metadataFilter6fields6offset5limitAA14PagingIteratorCyAA0C6ResultCGSSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA9_A9_A9_s5Int64VSgA12_A5_A5_SayAA0C11ContentTypeOGSgAA0C8ItemTypeOSgSbSgAA08MetadataC6FilterCSgA5_SiSgA24_tF":{"name":"queryWithSharedLinks(query:scope:fileExtensions:createdAfter:createdBefore:updatedAfter:updatedBefore:sizeAtLeast:sizeAtMost:ownerUserIDs:ancestorFolderIDs:searchIn:itemType:searchTrash:metadataFilter:fields:offset:limit:)","abstract":"

    Searches for items in Box, including items that a user might have accessed recently through a shared link.

    ","parent_name":"SearchModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC3get8policyId10completionySS_ys6ResultOyAA0C6PolicyCAA0A8SDKErrorCGctF":{"name":"get(policyId:completion:)","abstract":"

    Retrieves information about a retention policy

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6create4name4type6length17dispositionAction014canOwnerExtendC017areOwnersNotified28customNotificationRecipients10completionySS_AA0C10PolicyTypeOSiSgAA011DispositionK0OSbSgARSayAA4UserCGSgys6ResultOyAA0cV0CAA0A8SDKErrorCGctF":{"name":"create(name:type:length:dispositionAction:canOwnerExtendRetention:areOwnersNotified:customNotificationRecipients:completion:)","abstract":"

    Creates a new retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6update8policyId4name17dispositionAction6status10completionySS_SSSgAA011DispositionK0OSgAA0C12PolicyStatusOSgys6ResultOyAA0cO0CAA0A8SDKErrorCGctF":{"name":"update(policyId:name:dispositionAction:status:completion:)","abstract":"

    Updates existing retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC4list4name4type15createdByUserId6marker5limitAA14PagingIteratorCyAA0C11PolicyEntryCGSSSg_AA0cQ4TypeOSgA2OSiSgtF":{"name":"list(name:type:createdByUserId:marker:limit:)","abstract":"

    Retrieves all of the retention policies for the given enterprise.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC13getAssignment12assignmentId10completionySS_ys6ResultOyAA0c6PolicyG0CAA0A8SDKErrorCGctF":{"name":"getAssignment(assignmentId:completion:)","abstract":"

    Retrieves information about a retention policy assignment.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6assign8policyId015assignedContentH00fJ4Type12filterFields10completionySS_SSAA0c20PolicyAssignmentItemK0OSayAA19MetadataFieldFilterVGSgys6ResultOyAA0coP0CAA0A8SDKErrorCGctF":{"name":"assign(policyId:assignedContentId:assignContentType:filterFields:completion:)","abstract":"

    Creates new retention policy assignment to a content.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC15listAssignments8policyId4type6marker5limitAA14PagingIteratorCyAA0C16PolicyAssignmentCGSS_AA0cO4TypeOSgSSSgSiSgtF":{"name":"listAssignments(policyId:type:marker:limit:)","abstract":"

    Returns a list of all retention policy assignments associated with a specified retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RecentItemsModule.html#/s:6BoxSDK17RecentItemsModuleC4list6marker5limit6fieldsAA14PagingIteratorCyAA0C4ItemCGSSSg_SiSgSaySSGSgtF":{"name":"list(marker:limit:fields:)","abstract":"

    Get recent items.

    ","parent_name":"RecentItemsModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list9forFileId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF":{"name":"list(forFileId:completion:)","abstract":"

    Retrieve all metadata associated with a given file

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"get(forFileWithId:scope:templateKey:completion:)","abstract":"

    Get the metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create13forFileWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"create(forFileWithId:scope:templateKey:keys:completion:)","abstract":"

    Create a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update13forFileWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"update(forFileWithId:scope:templateKey:operations:completion:)","abstract":"

    Update a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(forFileWithId:scope:templateKey:completion:)","abstract":"

    Delete a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list11forFolderId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF":{"name":"list(forFolderId:completion:)","abstract":"

    Retrieve all metadata associated with a given folder

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"get(forFolderWithId:scope:templateKey:completion:)","abstract":"

    Get the metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create15forFolderWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"create(forFolderWithId:scope:templateKey:keys:completion:)","abstract":"

    Create a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update15forFolderWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"update(forFolderWithId:scope:templateKey:operations:completion:)","abstract":"

    Update a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(forFolderWithId:scope:templateKey:completion:)","abstract":"

    Delete a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC16getTemplateByKey5scope08templateH010completionySS_SSys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"getTemplateByKey(scope:templateKey:completion:)","abstract":"

    Get metadata template by name (templateKey).

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC15getTemplateById2id10completionySS_ys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"getTemplateById(id:completion:)","abstract":"

    Get metadata template by ID.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14createTemplate5scope11templateKey11displayName6hidden22copyInstanceOnItemCopy6fields10completionySS_S2SS2bSgSayAA0C5FieldVGys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"createTemplate(scope:templateKey:displayName:hidden:copyInstanceOnItemCopy:fields:completion:)","abstract":"

    Create metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14updateTemplate5scope11templateKey9operation10completionySS_SSAA0cF9OperationOys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"updateTemplate(scope:templateKey:operation:completion:)","abstract":"

    Update metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14deleteTemplate5scope11templateKey10completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteTemplate(scope:templateKey:completion:)","abstract":"

    Delete metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC23listEnterpriseTemplates5scope6marker5limitAA14PagingIteratorCyAA0C8TemplateCGSS_SSSgSiSgtF":{"name":"listEnterpriseTemplates(scope:marker:limit:)","abstract":"

    Retrieve all metadata templates within the specified enterprise

    ","parent_name":"MetadataModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC4list8folderId015ownerEnterpriseI06fields6marker5limitAA14PagingIteratorCyAA0cdE0CGSS_SSSgSaySSGSgAOSiSgtF":{"name":"list(folderId:ownerEnterpriseId:fields:marker:limit:)","abstract":"

    Retrieve an iterator for available metadata cascade policies within a given folder for the current enterprise.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC3get2id6fields10completionySS_SaySSGSgys6ResultOyAA0cdE0CAA0A8SDKErrorCGctF":{"name":"get(id:fields:completion:)","abstract":"

    Get information about a specific metadata cascade policy.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC6create8folderId5scope11templateKey6fields10completionySS_AA0C5ScopeOSSSaySSGSgys6ResultOyAA0cdE0CAA0A8SDKErrorCGctF":{"name":"create(folderId:scope:templateKey:fields:completion:)","abstract":"

    Create a metadata cascade policy that applies to a given folder and a metadata instance attached to the given folder.","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC6delete2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(id:completion:)","abstract":"

    Delete a metadata cascade policy that applies to a given folder and a folder-attached instance of given template.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC10forceApply2id18conflictResolution10completionySS_AA08ConflictK0Oys6ResultOyytAA0A8SDKErrorCGctF":{"name":"forceApply(id:conflictResolution:completion:)","abstract":"

    If a policy already exists on a folder, this will apply that policy to all existing files and sub-folders within the target folder.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC3get8policyId6fields10completionySS_SaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"get(policyId:fields:completion:)","abstract":"

    Get information about a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6create10policyName11description15filterStartedAt0j5EndedL09isOngoing6fields10completionySS_SSSg10Foundation4DateVSgAPSbSgSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"create(policyName:description:filterStartedAt:filterEndedAt:isOngoing:fields:completion:)","abstract":"

    Create a new legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6update8policyId0G4Name11description12releaseNotes6fields10completionySS_SSSgA2KSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"update(policyId:policyName:description:releaseNotes:fields:completion:)","abstract":"

    Update a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6delete8policyId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(policyId:completion:)","abstract":"

    Deletes a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC17listForEnterprise10policyName6marker5limit6fieldsAA14PagingIteratorCyAA0C10HoldPolicyCGSSSg_ANSiSgSaySSGSgtF":{"name":"listForEnterprise(policyName:marker:limit:fields:)","abstract":"

    Get all of the legal hold policies for the enterprise.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC19getPolicyAssignment12assignmentId6fields10completionySS_SaySSGSgys6ResultOyAA0c4HoldgH0CAA0A8SDKErrorCGctF":{"name":"getPolicyAssignment(assignmentId:fields:completion:)","abstract":"

    Get information about a policy assignmnet.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC12assignPolicy8policyId0f2ToI00fJ4Type6fields10completionySS_S2SSaySSGSgys6ResultOyAA0c4HoldG10AssignmentCAA0A8SDKErrorCGctF":{"name":"assignPolicy(policyId:assignToId:assignToType:fields:completion:)","abstract":"

    Assign a legal hold to a file, file version, folder, or user.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC22deletePolicyAssignment12assignmentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deletePolicyAssignment(assignmentId:completion:)","abstract":"

    Sends a request to delete an existing policy assignment.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC21listPolicyAssignments8policyId12assignToType0klJ06marker5limit6fieldsAA14PagingIteratorCyAA0c4HoldG10AssignmentCGSS_SSSgA2PSiSgSaySSGSgtF":{"name":"listPolicyAssignments(policyId:assignToType:assignToId:marker:limit:fields:)","abstract":"

    Get all of the assignments for a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC20getFileVersionPolicy11legalHoldId6fields10completionySS_SaySSGSgys6ResultOyAA0ghcK0CAA0A8SDKErrorCGctF":{"name":"getFileVersionPolicy(legalHoldId:fields:completion:)","abstract":"

    Get information about a file version legal hold.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC23listFileVersionPolicies8policyId6marker5limit6fieldsAA14PagingIteratorCyAA0ghC4HoldCGSS_SSSgSiSgSaySSGSgtF":{"name":"listFileVersionPolicies(policyId:marker:limit:fields:)","abstract":"

    Get all of the non-deleted legal holds for a single legal hold policy

    ","parent_name":"LegalHoldsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC3get7groupId6fields10completionySS_SaySSGSgys6ResultOyAA5GroupCAA0A8SDKErrorCGctF":{"name":"get(groupId:fields:completion:)","abstract":"

    Retrieves a specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6create4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityM06fields10completionySS_SSSgA2mA017GroupInvitabilityM0OSgAA0r6MemberoM0OSgSaySSGSgys6ResultOyAA0R0CAA0A8SDKErrorCGctF":{"name":"create(name:provenance:externalSyncIdentifier:description:invitabilityLevel:memberViewabilityLevel:fields:completion:)","abstract":"

    Creates a new Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6update7groupId4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityO06fields10completionySS_SSSgAA17NullableParameterOySSGSgA2rA017GroupInvitabilityO0OSgAA0v6MemberqO0OSgSaySSGSgys6ResultOyAA0V0CAA0A8SDKErrorCGctF":{"name":"update(groupId:name:provenance:externalSyncIdentifier:description:invitabilityLevel:memberViewabilityLevel:fields:completion:)","abstract":"

    Updates the specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6delete7groupId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(groupId:completion:)","abstract":"

    Deletes the specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17listForEnterprise4name6offset5limit6fieldsAA14PagingIteratorCyAA5GroupCGSSSg_SiSgAOSaySSGSgtF":{"name":"listForEnterprise(name:offset:limit:fields:)","abstract":"

    Get all Groups for an enterprise.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17getMembershipInfo12membershipId6fields10completionySS_SaySSGSgys6ResultOyAA05GroupF0CAA0A8SDKErrorCGctF":{"name":"getMembershipInfo(membershipId:fields:completion:)","abstract":"

    Retrieves a specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16createMembership6userId05groupH04role22configurablePermission6fields10completionySS_SSAA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableL4DataVGSgSaySSGSgys6ResultOyAA0oF0CAA0A8SDKErrorCGctF":{"name":"createMembership(userId:groupId:role:configurablePermission:fields:completion:)","abstract":"

    Creates a Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16updateMembership12membershipId4role22configurablePermission6fields10completionySS_AA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableK4DataVGSgSaySSGSgys6ResultOyAA0nF0CAA0A8SDKErrorCGctF":{"name":"updateMembership(membershipId:role:configurablePermission:fields:completion:)","abstract":"

    Updates the specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16deleteMembership12membershipId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteMembership(membershipId:completion:)","abstract":"

    Deletes the specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC15listMemberships7groupId6offset5limit6fieldsAA14PagingIteratorCyAA15GroupMembershipCGSS_SiSgANSaySSGSgtF":{"name":"listMemberships(groupId:offset:limit:fields:)","abstract":"

    Get all Memberships for a specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC22listMembershipsForUser6userId6offset5limit6fieldsAA14PagingIteratorCyAA15GroupMembershipCGSS_SiSgANSaySSGSgtF":{"name":"listMembershipsForUser(userId:offset:limit:fields:)","abstract":"

    Returns all of the group memberships for a given user. Note this is only available to group admins.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC18listCollaborations7groupId6offset5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SiSgANSaySSGSgtF":{"name":"listCollaborations(groupId:offset:limit:fields:)","abstract":"

    Returns all of the group collaborations for a given group. Note this is only available to group admins.

    ","parent_name":"GroupsModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC3get8folderId6fields10completionySS_SaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"get(folderId:fields:completion:)","abstract":"

    Get information about a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listItems8folderId9usemarker6marker6offset5limit4sort9direction6fieldsAA14PagingIteratorCyAA10FolderItemOGSS_SbSgSSSgSiSgAtA0rF7OrderByOSgAA0T9DirectionOSgSaySSGSgtF":{"name":"listItems(folderId:usemarker:marker:offset:limit:sort:direction:fields:)","abstract":"

    Gets all of the files, folders, or web links contained within a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6create4name8parentId6fields10completionySS_SSSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"create(name:parentId:fields:completion:)","abstract":"

    Create a new folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6update8folderId4name11description06parentG010sharedLink0F17UploadEmailAccess4tags18canNonOwnersInvite37isCollaborationRestrictedToEnterprise11collections6fields10completionySS_SSSgA2qA17NullableParameterOyAA06SharedL4DataVGSgAA06FoldermnO0OSgSaySSGSgSbSgA1_A0_A0_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"update(folderId:name:description:parentId:sharedLink:folderUploadEmailAccess:tags:canNonOwnersInvite:isCollaborationRestrictedToEnterprise:collections:fields:completion:)","abstract":"

    Update a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6delete8folderId9recursive10completionySS_SbSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(folderId:recursive:completion:)","abstract":"

    Delete a folder or move a folder to the trash. The recursive parameter must be included in","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC4copy8folderId19destinationFolderID4name6fields10completionySS_S2SSgSaySSGSgys6ResultOyAA0I0CAA0A8SDKErrorCGctF":{"name":"copy(folderId:destinationFolderID:name:fields:completion:)","abstract":"

    Used to create a copy of a folder in another folder. The original version of the folder will not be altered.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC18listCollaborations8folderId6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SaySSGSgtF":{"name":"listCollaborations(folderId:fields:)","abstract":"

    Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14addToFavorites8folderId10completionySS_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"addToFavorites(folderId:completion:)","abstract":"

    Add folder to favorites

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC15addToCollection8folderId010collectionI010completionySS_SSys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"addToCollection(folderId:collectionId:completion:)","abstract":"

    Add folder to particular collection

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC19removeFromFavorites8folderId10completionySS_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"removeFromFavorites(folderId:completion:)","abstract":"

    Remove folder from favorites

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC20removeFromCollection8folderId010collectionI010completionySS_SSys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"removeFromCollection(folderId:collectionId:completion:)","abstract":"

    Add folder to particular collection

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13getSharedLink9forFolder10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forFolder:completion:)","abstract":"

    Gets folder with updated shared link

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13setSharedLink9forFolder6access10unsharedAt8password11canDownload10completionySS_AA0fG6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forFolder:access:unsharedAt:password:canDownload:completion:)","abstract":"

    Creates or updates shared link for a folder

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC16deleteSharedLink9forFolder10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forFolder:completion:)","abstract":"

    Removes shared link for a folder

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC12getWatermark8folderId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getWatermark(folderId:completion:)","abstract":"

    Retrieves the watermark on a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14applyWatermark8folderId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"applyWatermark(folderId:completion:)","abstract":"

    Apply or update the watermark on a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC15removeWatermark8folderId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"removeWatermark(folderId:completion:)","abstract":"

    Remove the watermark from a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listLocks8folderIdAA14PagingIteratorCyAA10FolderLockCGSS_tF":{"name":"listLocks(folderId:)","abstract":"

    Get all of the locks on a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10createLock8folderId10completionySS_ys6ResultOyAA06FolderF0CAA0A8SDKErrorCGctF":{"name":"createLock(folderId:completion:)","abstract":"

    Creates a folder lock on a folder, preventing it from being moved and/or deleted.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10deleteLock06folderF2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteLock(folderLockId:completion:)","abstract":"

    Remove the specified folder lock.

    ","parent_name":"FoldersModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC3get6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"get(fileId:fields:completion:)","abstract":"

    Get information about a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6update6fileId4name11description06parentG010sharedLink4tags11collections4lock7ifMatch6fields10completionySS_SSSgA2pA17NullableParameterOyAA06SharedL4DataVGSgSaySSGSgAxRyAA04LockW0VGSgApXys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"update(fileId:name:description:parentId:sharedLink:tags:collections:lock:ifMatch:fields:completion:)","abstract":"

    Update the information about a file, including renaming or moving the file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4copy6fileId06parentG04name7version6fields10completionySS_S2SSgAKSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"copy(fileId:parentId:name:version:fields:completion:)","abstract":"

    Create a copy of a file in another folder. The original version of the file will not be","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6upload4data4name8parentId8progress21performPreflightCheck10completionAA0A10UploadTaskC10Foundation4DataV_S2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"upload(data:name:parentId:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13uploadVersion7forFile4name17contentModifiedAt4data7ifMatch8progress21performPreflightCheck10completionAA0A10UploadTaskCSS_SSSgAO10Foundation4DataVAOySo10NSProgressCcSbys6ResultOyAA0H0CAA0A8SDKErrorCGctF":{"name":"uploadVersion(forFile:name:contentModifiedAt:data:ifMatch:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12streamUpload0E08fileSize4name8parentId8progress21performPreflightCheck10completionAA0aF4TaskCSo13NSInputStreamC_SiS2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"streamUpload(stream:fileSize:name:parentId:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19streamUploadVersion0E08fileSize7forFile4name17contentModifiedAt7ifMatch8progress21performPreflightCheck10completionAA0aF4TaskCSo13NSInputStreamC_SiS3SSgARySo10NSProgressCcSbys6ResultOyAA0K0CAA0A8SDKErrorCGctF":{"name":"streamUploadVersion(stream:fileSize:forFile:name:contentModifiedAt:ifMatch:progress:performPreflightCheck:completion:)","abstract":"

    Upload a new version of an existing file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14preflightCheck4name8parentId4size10completionAA0A11NetworkTaskCSS_SSs5Int64VSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"preflightCheck(name:parentId:size:completion:)","abstract":"

    Verifies that new file will be accepted by Box before you send all the bytes over the wire.","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC27preflightCheckForNewVersion7forFile4name4size10completionAA0A11NetworkTaskCSS_SSSgs5Int64VSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"preflightCheckForNewVersion(forFile:name:size:completion:)","abstract":"

    Verifies that an updated file will be accepted by Box before you send all the bytes over the wire. It’s used before","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4lock6fileId9expiresAt19isDownloadPrevented6fields10completionySS_10Foundation4DateVSgSbSgSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"lock(fileId:expiresAt:isDownloadPrevented:fields:completion:)","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6unlock6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"unlock(fileId:fields:completion:)","abstract":"

    Unlock a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getThumbnail7forFile9extension9minHeight0J5Width03maxK00mL010completionySS_AA0F9ExtensionOSiSgA3Nys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF":{"name":"getThumbnail(forFile:extension:minHeight:minWidth:maxHeight:maxWidth:completion:)","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getEmbedLink7forFile10completionySS_ys6ResultOyAA08ExpiringfG0CAA0A8SDKErrorCGctF":{"name":"getEmbedLink(forFile:completion:)","abstract":"

    Get a URL for creating an embedded preview session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC18listCollaborations7forFile6marker5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SSSgSiSgSaySSGSgtF":{"name":"listCollaborations(forFile:marker:limit:fields:)","abstract":"

    Get all of the collaborations on a file (i.e. all of the users that have access to that file).

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listComments7forFile6offset5limit6fieldsAA14PagingIteratorCyAA7CommentCGSS_SiSgANSaySSGSgtF":{"name":"listComments(forFile:offset:limit:fields:)","abstract":"

    Get all of the comments on a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC9listTasks7forFile6fieldsAA14PagingIteratorCyAA4TaskCGSS_SaySSGSgtF":{"name":"listTasks(forFile:fields:)","abstract":"

    Get all of the tasks for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC8download6fileId14destinationURL7version8progress10completionAA0A12DownloadTaskCSS_10Foundation0I0VSSSgySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"download(fileId:destinationURL:version:progress:completion:)","abstract":"

    Download a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6delete6fileId7ifMatch10completionySS_SSSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(fileId:ifMatch:completion:)","abstract":"

    Discards a file to the trash. The etag of the file can be included as an ‘If-Match’ header to prevent race conditions.","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14addToFavorites6fileId10completionySS_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"addToFavorites(fileId:completion:)","abstract":"

    Add file to favorites

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15addToCollection6fileId010collectionI010completionySS_SSys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"addToCollection(fileId:collectionId:completion:)","abstract":"

    Add file to particular collection

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19removeFromFavorites6fileId10completionySS_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"removeFromFavorites(fileId:completion:)","abstract":"

    Remove file from favorites

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC20removeFromCollection6fileId010collectionI010completionySS_SSys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"removeFromCollection(fileId:collectionId:completion:)","abstract":"

    Add file to particular collection

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listVersions6fileId6offset5limit6fieldsAA14PagingIteratorCyAA11FileVersionCGSS_SiSgANSaySSGSgtF":{"name":"listVersions(fileId:offset:limit:fields:)","abstract":"

    Retrieves all file versions on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10getVersion6fileId0gfH06fields10completionySS_SSSaySSGSgys6ResultOyAA04FileF0CAA0A8SDKErrorCGctF":{"name":"getVersion(fileId:fileVersionId:fields:completion:)","abstract":"

    Retrieves a specified file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14promoteVersion6fileId0gfH06fields10completionySS_SSSaySSGSgys6ResultOyAA04FileF0CAA0A8SDKErrorCGctF":{"name":"promoteVersion(fileId:fileVersionId:fields:completion:)","abstract":"

    Promotes the specified file version to the current file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13deleteVersion6fileId0gfH07ifMatch10completionySS_S2SSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteVersion(fileId:fileVersionId:ifMatch:completion:)","abstract":"

    Discards the specified file version to the trash.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getWatermark6fileId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getWatermark(fileId:completion:)","abstract":"

    Retrieves the watermark on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14applyWatermark6fileId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"applyWatermark(fileId:completion:)","abstract":"

    Apply or update the watermark on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15removeWatermark6fileId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"removeWatermark(fileId:completion:)","abstract":"

    Remove the watermark from a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13getSharedLink7forFile10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forFile:completion:)","abstract":"

    Gets file with updated shared link

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13setSharedLink7forFile10unsharedAt6access8password11canDownload10completionySS_AA17NullableParameterOy10Foundation4DateVGSgAA0fG6AccessOSgALySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forFile:unsharedAt:access:password:canDownload:completion:)","abstract":"

    Creates of updates shared link for a file

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16deleteSharedLink7forFile10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forFile:completion:)","abstract":"

    Removes shared link for a file

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11downloadZip4name5items14destinationURL10completionySS_SayAA0F12DownloadItemVG10Foundation0J0Vys6ResultOyAA0fL6StatusCAA0A8SDKErrorCGctF":{"name":"downloadZip(name:items:destinationURL:completion:)","abstract":"

    Creates a zip of multiple files and folders and downloads it.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19createUploadSession8folderId8fileName0J4Size10completionySS_SSs5Int32Vys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createUploadSession(folderId:fileName:fileSize:completion:)","abstract":"

    Create an upload session for uploading a new file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC32createUploadSessionForNewVersion6ofFile8fileName0M4Size10completionySS_SSSgs5Int32Vys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createUploadSessionForNewVersion(ofFile:fileName:fileSize:completion:)","abstract":"

    Create an upload session for uploading a new file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10uploadPart9sessionId4data6offset9totalSize8progress10completionAA0A10UploadTaskCSS_10Foundation4DataVS2iySo10NSProgressCcys6ResultOyAA0oF0CAA0A8SDKErrorCGctF":{"name":"uploadPart(sessionId:data:offset:totalSize:progress:completion:)","abstract":"

    Upload a part of the file to this session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC22listUploadSessionParts9sessionId6offset5limitAA14PagingIteratorCyAA0F15PartDescriptionVGSS_SiSgAMtF":{"name":"listUploadSessionParts(sessionId:offset:limit:)","abstract":"

    Get list of parts of chunked upload session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12commitUpload9sessionId5parts4sha111description10sharedLink4tags11collections4lock16contentCreatedAt0q8ModifiedS010completionySS_SayAA0F15PartDescriptionVGS2SSgAA06SharedM4DataVSgSaySSGSgAxA04LockY0VSg10Foundation4DateVSgA3_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"commitUpload(sessionId:parts:sha1:description:sharedLink:tags:collections:lock:contentCreatedAt:contentModifiedAt:completion:)","abstract":"

    Commit upload session after successful upload of all parts.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11abortUpload9sessionId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"abortUpload(sessionId:completion:)","abstract":"

    Abort chunked upload session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16getUploadSession9sessionId10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getUploadSession(sessionId:completion:)","abstract":"

    Get chunked upload session with ID.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19listRepresentations6fileId18representationHint10completionySS_AA018FileRepresentationJ0OSgys6ResultOySayAA0lM0VGAA0A8SDKErrorCGctF":{"name":"listRepresentations(fileId:representationHint:completion:)","abstract":"

    Get representations for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC24getRepresentationContent6fileId18representationHint9assetPath14destinationURL8progress10completionySS_AA04FilefK0OSS10Foundation0O0VySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"getRepresentationContent(fileId:representationHint:assetPath:destinationURL:progress:completion:)","abstract":"

    Get particular representation for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC22downloadRepresentation9sourceURL011destinationH08progress10completionAA0A12DownloadTaskC10Foundation0H0V_AMySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"downloadRepresentation(sourceURL:destinationURL:progress:completion:)","abstract":"

    Download a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19getVersionRetention11retentionId10completionySS_ys6ResultOyAA04FilefG0CAA0A8SDKErrorCGctF":{"name":"getVersionRetention(retentionId:completion:)","abstract":"

    Retrieves information about a file version retention policy.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC21listVersionRetentions6fileId0hfI006policyI017dispositionAction0K6Before0K5After5limit6markerAA14PagingIteratorCyAA04FileF9RetentionCGSSSg_A2rA011DispositionL0OSg10Foundation4DateVSgAYSiSgARtF":{"name":"listVersionRetentions(fileId:fileVersionId:policyId:dispositionAction:dispositionBefore:dispositionAfter:limit:marker:)","abstract":"

    Retrieves all file version retentions for the given enterprise.

    ","parent_name":"FilesModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC07getUserC010streamType0G8Position5limitAA14PagingIteratorCyAA5EventCGAA06StreamH0OSg_AA0nI0OSgSiSgtF":{"name":"getUserEvents(streamType:streamPosition:limit:)","abstract":"

    Gets events for the current user associated with the access token.","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC013getEnterpriseC010eventTypes12createdAfter0I6Before14streamPosition5limitAA14PagingIteratorCyAA5EventCGSayAA0Q4TypeOGSg_10Foundation4DateVSgAvA06StreamM0OSgSiSgtF":{"name":"getEnterpriseEvents(eventTypes:createdAfter:createdBefore:streamPosition:limit:)","abstract":"

    Gets events for all users and content in the enterprise. Enterprise events are accessible for one year via the API,","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC13getPollingURL10completionyys6ResultOyAA0F7URLInfoCAA0A8SDKErrorCGc_tF":{"name":"getPollingURL(completion:)","abstract":"

    Gets polling URL for checking new changes in an event stream. Works only for user events.

    ","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC013observeForNewC04with10completionyAA14PollingURLInfoC_ys6ResultOyAA0jL0CAA0A8SDKErrorCGctF":{"name":"observeForNewEvents(with:completion:)","abstract":"

    Makes long-polling request for new changes. Server does not return response immediatelly. It only returns response when either","parent_name":"EventsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC3get11devicePinId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(devicePinId:fields:completion:)","abstract":"

    Retrieves a specified Device Pin.

    ","parent_name":"DevicePinsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC17listForEnterprise12enterpriseId6marker5limit9direction6fieldsAA14PagingIteratorCyAA0C3PinCGSS_SSSgSiSgAA14OrderDirectionOSgSaySSGSgtF":{"name":"listForEnterprise(enterpriseId:marker:limit:direction:fields:)","abstract":"

    Retrieves all Device Pins for an enterprise.

    ","parent_name":"DevicePinsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC6delete11devicePinId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(devicePinId:completion:)","abstract":"

    Deletes the specified Device Pin.

    ","parent_name":"DevicePinsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC3get9commentId6fields10completionySS_SaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"get(commentId:fields:completion:)","abstract":"

    Get information about a comment.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6update9commentId7message6fields10completionySS_SSSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"update(commentId:message:fields:completion:)","abstract":"

    Updates the message for a comment.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6create6itemId0F4Type7message6fields10completionySS_S2SSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"create(itemId:itemType:message:fields:completion:)","abstract":"

    Creates a comment on an item.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6delete9commentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(commentId:completion:)","abstract":"

    Deletes the comment.

    ","parent_name":"CommentsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC4list6offset5limit6fieldsAA14PagingIteratorCyAA0A10CollectionCGSiSg_AMSaySSGSgtF":{"name":"list(offset:limit:fields:)","abstract":"

    Retrieves the collections for the given user.

    ","parent_name":"CollectionsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC12getFavorites6fields10completionySaySSGSg_ys6ResultOyAA0A10CollectionCAA0A8SDKErrorCGctF":{"name":"getFavorites(fields:completion:)","abstract":"

    Retrieve the favorites collection

    ","parent_name":"CollectionsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC9listItems12collectionId6offset5limit6fieldsAA14PagingIteratorCyAA10FolderItemOGSS_SiSgANSaySSGSgtF":{"name":"listItems(collectionId:offset:limit:fields:)","abstract":"

    Gets all of the files, folders, or web links contained within a collection.

    ","parent_name":"CollectionsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC3get15collaborationId6fields10completionySS_SaySSGSgys6ResultOyAA13CollaborationCAA0A8SDKErrorCGctF":{"name":"get(collaborationId:fields:completion:)","abstract":"

    Get information about a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6create8itemType0F2Id4role12accessibleBy0jkG011canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSAA010AccessibleK0OSbSgSaySSGSgARys6ResultOyAA0R0CAA0A8SDKErrorCGctF":{"name":"create(itemType:itemId:role:accessibleBy:accessibleByType:canViewPath:fields:notify:completion:)","abstract":"

    Create a new collaboration that grants a group access to a file or folder in a specific role.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC17createByUserEmail8itemType0I2Id4role5login11canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSSbSgSaySSGSgAOys6ResultOyAA0T0CAA0A8SDKErrorCGctF":{"name":"createByUserEmail(itemType:itemId:role:login:canViewPath:fields:notify:completion:)","abstract":"

    Create a new collaboration that grants a user to a file or folder in a specific role.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6update15collaborationId4role6status11canViewPath6fields10completionySS_AA17CollaborationRoleOAA0O6StatusOSgSbSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"update(collaborationId:role:status:canViewPath:fields:completion:)","abstract":"

    Update a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6delete15collaborationId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(collaborationId:completion:)","abstract":"

    Delete a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC24listPendingForEnterprise6offset5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSiSg_AMSaySSGSgtF":{"name":"listPendingForEnterprise(offset:limit:fields:)","abstract":"

    Get information about a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC31getAcceptanceRequirementsStatus15collaborationId10completionySS_ys6ResultOyAA13CollaborationC0fgH0CAA0A8SDKErrorCGctF":{"name":"getAcceptanceRequirementsStatus(collaborationId:completion:)","abstract":"

    Retrieves the acceptance requirements status for a specified collaboration

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC11listEntries6fields6marker5limitAA14PagingIteratorCyAA0cD5EntryCGSaySSGSg_SSSgSiSgtF":{"name":"listEntries(fields:marker:limit:)","abstract":"

    Returns the list of Allowlist entries for the current Enterprise. Each entry lists type, id,","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC3get2id6fields10completionySS_SaySSGSgys6ResultOyAA0cD5EntryCAA0A8SDKErrorCGctF":{"name":"get(id:fields:completion:)","abstract":"

    Get Collaboration Allowlist Entry by ID.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC6create6domain9direction6fields10completionySS_AA0C9DirectionOSaySSGSgys6ResultOyAA0cD5EntryCAA0A8SDKErrorCGctF":{"name":"create(domain:direction:fields:completion:)","abstract":"

    Create Collaboration Allowlist Entry.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC6delete2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(id:completion:)","abstract":"

    Remove a single item from the Enterprise’s Collaboration Allowlist by id.","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC17listExemptTargets6marker5limit6fieldsAA14PagingIteratorCyAA0cdG6TargetCGSSSg_SiSgSaySSGSgtF":{"name":"listExemptTargets(marker:limit:fields:)","abstract":"

    Returns an interator for listing of Exempt User entries for the current Enterprise.","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC15getExemptTarget2id6fields10completionySS_SaySSGSgys6ResultOyAA0cdgH0CAA0A8SDKErrorCGctF":{"name":"getExemptTarget(id:fields:completion:)","abstract":"

    Returns a specific exempt target for the passed in ID.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC10exemptUser6userId6fields10completionySS_SaySSGSgys6ResultOyAA0cD12ExemptTargetCAA0A8SDKErrorCGctF":{"name":"exemptUser(userId:fields:completion:)","abstract":"

    Creates the Exempt Target entry.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC18deleteExemptTarget2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteExemptTarget(id:completion:)","abstract":"

    Remove a single user from the exempt target list.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC7refresh0E5Token10completionySS_ys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"refresh(refreshToken:completion:)","abstract":"

    Refresh the given token.

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC8getToken8withCode10completionySS_ys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"getToken(withCode:completion:)","abstract":"

    Exchange an authorization code for an access token

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC11revokeToken5token10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"revokeToken(token:completion:)","abstract":"

    Revokes an access or refresh token, rendering it invalid.

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC14downscopeToken06parentF05scope8resource10sharedLink10completionySS_ShyAA0F5ScopeOGSSSgAMys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(parentToken:scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"AuthModule"},"Classes/FileLogDestination.html#/s:6BoxSDK18FileLogDestinationC7fileURLAC10Foundation0G0V_tcfc":{"name":"init(fileURL:)","abstract":"

    Intializer.

    ","parent_name":"FileLogDestination"},"Classes/FileLogDestination.html#/s:6BoxSDK18FileLogDestinationC5write_5level8category_ys12StaticStringV_AA0D5LevelOAA0D8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message into a file

    ","parent_name":"FileLogDestination"},"Classes/ConsoleLogDestination.html#/s:6BoxSDK21ConsoleLogDestinationC5write_5level8category_ys12StaticStringV_AA0D5LevelOAA0D8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message into the console

    ","parent_name":"ConsoleLogDestination"},"Classes/MetadataSearchFilter.html#/s:6BoxSDK20MetadataSearchFilterCACycfc":{"name":"init()","abstract":"

    Initializer

    ","parent_name":"MetadataSearchFilter"},"Classes/MetadataSearchFilter.html#/s:6BoxSDK20MetadataSearchFilterC03addE011templateKey05fieldH00I5Value5scope8relationySS_S2SAA0C5ScopeOAA0cE5BoundOtF":{"name":"addFilter(templateKey:fieldKey:fieldValue:scope:relation:)","abstract":"

    Adds a new filter object to our list of filter objects.

    ","parent_name":"MetadataSearchFilter"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC9errorTypeSSvp":{"name":"errorType","abstract":"

    Type of error

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC7messageAA0aC4EnumOvp":{"name":"message","abstract":"

    Error message

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC10stackTraceSaySSGvp":{"name":"stackTrace","abstract":"

    Stack trace

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC5errors5Error_pSgvp":{"name":"error","abstract":"

    Error

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC13getDictionarySDySSypGyF":{"name":"getDictionary()","abstract":"

    Get a dictionary representing BoxSDKError

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC11descriptionSSvp":{"name":"description","abstract":"

    Provides error JSON string if found.

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"BoxSDKError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC7requestAA0A18RequestDescriptionVSgvp":{"name":"request","abstract":"

    The components that make up a description of a BoxRequest

    ","parent_name":"BoxAPIError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC8responseAA0A19ResponseDescriptionVSgvp":{"name":"response","abstract":"

    The components that make up a description of a BoxResponse

    ","parent_name":"BoxAPIError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC13getDictionarySDySSypGyF":{"name":"getDictionary()","abstract":"

    Get a dictionary representing BoxAPIError

    ","parent_name":"BoxAPIError"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5filesAA11FilesModuleCvp":{"name":"files","abstract":"

    Provides File management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7foldersAA13FoldersModuleCvp":{"name":"folders","abstract":"

    Provides Folder management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5usersAA11UsersModuleCvp":{"name":"users","abstract":"

    Provides User management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6groupsAA12GroupsModuleCvp":{"name":"groups","abstract":"

    Provides Group management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8commentsAA14CommentsModuleCvp":{"name":"comments","abstract":"

    Provides Comment management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11sharedItemsAA06SharedE6ModuleCvp":{"name":"sharedItems","abstract":"

    Provides SharedItem management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8webLinksAA03WebE6ModuleCvp":{"name":"webLinks","abstract":"

    Web Links management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6searchAA12SearchModuleCvp":{"name":"search","abstract":"

    Provides search functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11collectionsAA17CollectionsModuleCvp":{"name":"collections","abstract":"

    Provides collections functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14collaborationsAA20CollaborationsModuleCvp":{"name":"collaborations","abstract":"

    Provides collaborations functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC22collaborationAllowListAA28CollaborationAllowlistModuleCvp":{"name":"collaborationAllowList","abstract":"

    Provides collaborations whitelist functionality

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8metadataAA14MetadataModuleCvp":{"name":"metadata","abstract":"

    Metadata management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6eventsAA12EventsModuleCvp":{"name":"events","abstract":"

    Provides Events management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC21metadataCascadePolicyAA08MetadataeF6ModuleCvp":{"name":"metadataCascadePolicy","abstract":"

    Metadata cascade policy.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5trashAA11TrashModuleCvp":{"name":"trash","abstract":"

    Trash management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC10devicePinsAA06DeviceE6ModuleCvp":{"name":"devicePins","abstract":"

    Device Pin management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11recentItemsAA06RecentE6ModuleCvp":{"name":"recentItems","abstract":"

    Recent Items management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8webhooksAA14WebhooksModuleCvp":{"name":"webhooks","abstract":"

    Webhooks management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5tasksAA11TasksModuleCvp":{"name":"tasks","abstract":"

    Tasks management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC15retentionPolicyAA23RetentionPoliciesModuleCvp":{"name":"retentionPolicy","abstract":"

    Retention policy management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14termsOfServiceAA05TermsE14ServicesModuleCvp":{"name":"termsOfService","abstract":"

    Provides TermsOfService

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC10legalHoldsAA05LegalE6ModuleCvp":{"name":"legalHolds","abstract":"

    Legal Hold Policies management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC15storagePoliciesAA07StorageE6ModuleCvp":{"name":"storagePolicies","abstract":"

    Storage Policies management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC12signRequestsAA04SignE6ModuleCvp":{"name":"signRequests","abstract":"

    Provides sign requests functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7sessionAA15SessionProtocol_pvp":{"name":"session","abstract":"

    Provides authentication session management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7headersSDyS2SGSgvp":{"name":"headers","abstract":"

    Requests header.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC13configurationAA0A16SDKConfigurationVvp":{"name":"configuration","abstract":"

    SDK request configuration.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11isDestroyedSbvp":{"name":"isDestroyed","abstract":"

    Indicates whether this BoxClient instance has been destroyed

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC21favoritesCollectionIdSSSgvp":{"name":"favoritesCollectionId","abstract":"

    ID of user’s favorites collection.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC12networkAgent7session13configurationAcA07NetworkE8Protocol_p_AA07SessionI0_pAA0A16SDKConfigurationVtcfc":{"name":"init(networkAgent:session:configuration:)","abstract":"

    Initializer

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14withSharedLink3url8passwordAC10Foundation3URLV_SSSgtF":{"name":"withSharedLink(url:password:)","abstract":"

    Creates BoxClient instance based on shared link URL and password.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6asUser6withIdACSS_tF":{"name":"asUser(withId:)","abstract":"

    Creates BoxClient instance based on user identifier.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7destroy10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"destroy(completion:)","abstract":"

    Destroys the client, revoking its access tokens and rendering it inoperable.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC13exchangeToken5scope8resource10sharedLink10completionyShyAA0E5ScopeOG_SSSgALys6ResultOyAA0E4InfoCAA0A8SDKErrorCGctF":{"name":"exchangeToken(scope:resource:sharedLink:completion:)","abstract":"

    Exchange the token.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3get3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"get(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP GET method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC4post3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC4post3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters4data8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAM4DataVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:data:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response - variant for chunked upload.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7options3url11httpHeaders15queryParameters4json10completionAA0A11NetworkTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"options(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP OPTIONS method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6delete3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"delete(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP DELETE method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8download3url0D14DestinationURL11httpHeaders15queryParameters8progress10completionAA0A12DownloadTaskC10Foundation0G0V_AOSDyS2SGSDySSAA25QueryParameterConvertible_pSgGySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"download(url:downloadDestinationURL:httpHeaders:queryParameters:progress:completion:)","abstract":"

    Performs an HTTP GET method call for downloading on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxSDK/Constants.html#/s:6BoxSDKAAC9ConstantsO10rootFolderSSvpZ":{"name":"rootFolder","abstract":"

    Root folder identifier

    ","parent_name":"Constants"},"Classes/BoxSDK/Constants.html#/s:6BoxSDKAAC9ConstantsO11currentUserSSvpZ":{"name":"currentUser","abstract":"

    Current user identifier

    ","parent_name":"Constants"},"Classes/BoxSDK/Constants.html":{"name":"Constants","abstract":"

    Box-specific constants

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC13configurationAA0A16SDKConfigurationVvp":{"name":"configuration","abstract":"

    SDK configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC20defaultConfigurationAA0A16SDKConfigurationVvpZ":{"name":"defaultConfiguration","abstract":"

    Default configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC4authAA10AuthModuleCvp":{"name":"auth","abstract":"

    Auth module providing authorization and token related requests.","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC8clientId0C6Secret11callbackURLABSS_S2SSgtcfc":{"name":"init(clientId:clientSecret:callbackURL:)","abstract":"

    Initializer

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC9getClient5tokenAA0aD0CSS_tFZ":{"name":"getClient(token:)","abstract":"

    Creates BoxClient object based on developer token

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC9getClient5tokenAA0aD0CSS_tF":{"name":"getClient(token:)","abstract":"

    Creates BoxClient with developer token

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC22getDelegatedAuthClient11authClosure8uniqueID9tokenInfo0K5Store10completionyySS_ys6ResultOySS11accessToken_Sd9expiresInts5Error_pGctc_SSAA0qL0CSgAA0qM0_pSgyAJyAA0aF0CAA0A8SDKErrorCGctF":{"name":"getDelegatedAuthClient(authClosure:uniqueID:tokenInfo:tokenStore:completion:)","abstract":"

    Creates BoxClient using JWT token.

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC15getOAuth2Client9tokenInfo0F5Store7context10completionyAA05TokenG0CSg_AA0kH0_pSgSo47ASWebAuthenticationPresentationContextProviding_pys6ResultOyAA0aE0CAA0A8SDKErrorCGctF":{"name":"getOAuth2Client(tokenInfo:tokenStore:context:completion:)","abstract":"

    Creates BoxClient in a completion with OAuth 2.0 type of authentication

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC15getOAuth2Client9tokenInfo0F5Store10completionyAA05TokenG0CSg_AA0jH0_pSgys6ResultOyAA0aE0CAA0A8SDKErrorCGctF":{"name":"getOAuth2Client(tokenInfo:tokenStore:completion:)","abstract":"

    Creates BoxClient in a completion with OAuth 2.0 type of authentication

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC19updateConfiguration10apiBaseURL09uploadApifG016maxRetryAttempts21tokenRefreshThreshold21consoleLogDestination04fileqR019clientAnalyticsInfoy10Foundation0G0VSg_ANSiSgSdSgAA07ConsoleqR0CSgAA04FileqR0CSgAA06ClientuV0VSgtKF":{"name":"updateConfiguration(apiBaseURL:uploadApiBaseURL:maxRetryAttempts:tokenRefreshThreshold:consoleLogDestination:fileLogDestination:clientAnalyticsInfo:)","abstract":"

    Updates current SDK configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC16makeAuthorizeURL5state10Foundation0E0VSSSg_tF":{"name":"makeAuthorizeURL(state:)","abstract":"

    Creates OAuth2 authorization URL you can use in browser to authorize.

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html":{"name":"BoxSDK","abstract":"

    Provides methods for creating BoxSDKClient

    "},"Classes/BoxClient.html":{"name":"BoxClient","abstract":"

    Provides communication with Box APIs. Defines methods for communication with Box APIs

    "},"Classes.html#/s:6BoxSDK0A12APIAuthErrorC":{"name":"BoxAPIAuthError","abstract":"

    Describes authentication errors.

    "},"Classes/BoxAPIError.html":{"name":"BoxAPIError","abstract":"

    Describes API request related errors.

    "},"Classes.html#/s:6BoxSDK0A11CodingErrorC":{"name":"BoxCodingError","abstract":"

    Describes encoding and decoding related errors.

    "},"Classes.html#/s:6BoxSDK0A12NetworkErrorC":{"name":"BoxNetworkError","abstract":"

    Describes network related errors.

    "},"Classes/BoxSDKError.html":{"name":"BoxSDKError","abstract":"

    Describes general SDK errors

    "},"Classes/MetadataSearchFilter.html":{"name":"MetadataSearchFilter","abstract":"

    Provides functionality for creating a Metadata Search Filter.

    "},"Classes/ConsoleLogDestination.html":{"name":"ConsoleLogDestination","abstract":"

    Defines logging into a console

    "},"Classes/FileLogDestination.html":{"name":"FileLogDestination","abstract":"

    Defines logging into a file

    "},"Classes/AuthModule.html":{"name":"AuthModule","abstract":"

    Provides Token management.

    "},"Classes/CollaborationAllowlistModule.html":{"name":"CollaborationAllowlistModule","abstract":"

    Provides Collaborations management.

    "},"Classes/CollaborationsModule.html":{"name":"CollaborationsModule","abstract":"

    Provides Collaborations management.

    "},"Classes/CollectionsModule.html":{"name":"CollectionsModule","abstract":"

    Management of collections of files and folders. The only collection available is the “Favorites”.

    "},"Classes/CommentsModule.html":{"name":"CommentsModule","abstract":"

    Provides Comment management

    "},"Classes/DevicePinsModule.html":{"name":"DevicePinsModule","abstract":"

    Provides DevicePin management.

    "},"Classes/EventsModule.html":{"name":"EventsModule","abstract":"

    Provides Event management.

    "},"Classes/FilesModule.html":{"name":"FilesModule","abstract":"

    Provides File management.

    "},"Classes/FoldersModule.html":{"name":"FoldersModule","abstract":"

    Provides Folder management.

    "},"Classes/GroupsModule.html":{"name":"GroupsModule","abstract":"

    Provides Group management

    "},"Classes/LegalHoldsModule.html":{"name":"LegalHoldsModule","abstract":"

    Provides management of Legal Holds

    "},"Classes/MetadataCascadePolicyModule.html":{"name":"MetadataCascadePolicyModule","abstract":"

    Defines methods for metadata management

    "},"Classes/MetadataModule.html":{"name":"MetadataModule","abstract":"

    Defines methods for metadata management

    "},"Classes/RecentItemsModule.html":{"name":"RecentItemsModule","abstract":"

    Returns information about files that have been accessed by a user not long ago.

    "},"Classes/RetentionPoliciesModule.html":{"name":"RetentionPoliciesModule","abstract":"

    Provides RetentionPolicy management.

    "},"Classes/SearchModule.html":{"name":"SearchModule","abstract":"

    Provides functionality to search for content.

    "},"Classes/SharedItemsModule.html":{"name":"SharedItemsModule","abstract":"

    Provides SharedItem management.

    "},"Classes/SignRequestsModule.html":{"name":"SignRequestsModule","abstract":"

    Provides management of Sign Requests

    "},"Classes/StoragePoliciesModule.html":{"name":"StoragePoliciesModule","abstract":"

    Provides management of Storage Policies

    "},"Classes/TasksModule.html":{"name":"TasksModule","abstract":"

    Provides Tasks management

    "},"Classes/TermsOfServicesModule.html":{"name":"TermsOfServicesModule","abstract":"

    Provides TermsOfService management.

    "},"Classes/TrashModule.html":{"name":"TrashModule","abstract":"

    Module for trash management

    "},"Classes/UsersModule.html":{"name":"UsersModule","abstract":"

    Provides User management.

    "},"Classes/WebLinksModule.html":{"name":"WebLinksModule","abstract":"

    Provides Web Link management.

    "},"Classes/WebhooksModule.html":{"name":"WebhooksModule","abstract":"

    Provides management of Webhooks

    "},"Classes.html#/s:6BoxSDK0A12DownloadTaskC":{"name":"BoxDownloadTask","abstract":"

    A Box network task for a download

    "},"Classes/BoxNetworkAgent.html":{"name":"BoxNetworkAgent","abstract":"

    Implementation of networking layer

    "},"Classes/BoxNetworkTask.html":{"name":"BoxNetworkTask","abstract":"

    A Box network task request.

    "},"Classes.html#/s:6BoxSDK0A10UploadTaskC":{"name":"BoxUploadTask","abstract":"

    A Box network task returned for a upload

    "},"Classes/PagingIterator.html":{"name":"PagingIterator","abstract":"

    Provides paged iterator access for a collection of BoxModel’s

    "},"Classes/BoxRequest.html":{"name":"BoxRequest","abstract":"

    Represents Box SDK API request.

    "},"Classes/BoxCollection.html":{"name":"BoxCollection","abstract":"

    Collections contain information about the items contained inside of them, including files and folders."},"Classes/Classification.html":{"name":"Classification","abstract":"

    Details about the classification applied to a Box file or folder

    "},"Classes/Collaboration.html":{"name":"Collaboration","abstract":"

    Defines access permissions for users and groups to files and folders, similar to access control lists."},"Classes/CollaborationAllowlistEntry.html":{"name":"CollaborationAllowlistEntry","abstract":"

    An allowlisted domain in the enterprise. This record consists of both direction"},"Classes/CollaborationAllowlistExemptTarget.html":{"name":"CollaborationAllowlistExemptTarget","abstract":"

    The record that represents a target (at the moment, only users are supported as targets)"},"Classes/Collaborator.html":{"name":"Collaborator","abstract":"

    User taking part in a collaboration.

    "},"Classes/Comment.html":{"name":"Comment","abstract":"

    Message generated by Box users. Each message is tied to a specific file."},"Classes/DevicePin.html":{"name":"DevicePin","abstract":"

    Defines a device pin which allows the enterprise to control devices connecting to it.

    "},"Classes/EmailAlias.html":{"name":"EmailAlias","abstract":"

    User’s email alias.

    "},"Classes/Enterprise.html":{"name":"Enterprise","abstract":"

    Enterprise

    "},"Classes/EntryContainer.html":{"name":"EntryContainer","abstract":"

    Container for an entries (Box items)

    "},"Classes/Order.html":{"name":"Order","abstract":"

    Defines the order of items

    "},"Classes/EntryContainerInnerModel.html":{"name":"EntryContainerInnerModel","abstract":"

    Entry container for items of inner model

    "},"Classes/Event.html":{"name":"Event","abstract":"

    An event object associated with user or enterprise events.

    "},"Classes/EventContainer.html":{"name":"EventContainer","abstract":"

    Container for Events

    "},"Classes/EventItem.html":{"name":"EventItem","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/ExpiringEmbedLink.html":{"name":"ExpiringEmbedLink","abstract":"

    Expiring embed link of a file

    "},"Classes/File.html":{"name":"File","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/FileVersion.html":{"name":"FileVersion","abstract":"

    Specific version of a file.

    "},"Classes/FileVersionLegalHold.html":{"name":"FileVersionLegalHold","abstract":"

    A file version legal hold object represents all holds on a file version

    "},"Classes/FileVersionRetention.html":{"name":"FileVersionRetention","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/Folder.html":{"name":"Folder","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/FolderLock.html":{"name":"FolderLock","abstract":"

    Folder Lock

    "},"Classes/FolderUploadEmail.html":{"name":"FolderUploadEmail","abstract":"

    Defines upload email address for a folder.

    "},"Classes/Group.html":{"name":"Group","abstract":"

    Contain a set of users, and can be used in place of users in some operations, such as collaborations.

    "},"Classes/GroupMembership.html":{"name":"GroupMembership","abstract":"

    Membership of a group

    "},"Classes/Invite.html":{"name":"Invite","abstract":"

    Defines invitation for a user to join enterprise

    "},"Classes/LegalHoldPolicy.html":{"name":"LegalHoldPolicy","abstract":"

    Legal hold policy

    "},"Classes/LegalHoldPolicyAssignment.html":{"name":"LegalHoldPolicyAssignment","abstract":"

    Legal hold policy assignment

    "},"Classes/LegalHoldPolicyAssignmentItem.html":{"name":"LegalHoldPolicyAssignmentItem","abstract":"

    Legal hold policy assignment item

    "},"Classes/Lock.html":{"name":"Lock","abstract":"

    Locks a file to prevent it from being modified

    "},"Classes/MetadataCascadePolicy.html":{"name":"MetadataCascadePolicy","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/MetadataObject.html":{"name":"MetadataObject","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/MetadataTemplate.html":{"name":"MetadataTemplate","abstract":"

    Metadata that belongs to a file or folder is grouped by templates."},"Classes/PathCollection.html":{"name":"PathCollection","abstract":"

    The path of folders to an item, starting at the root.

    "},"Classes/PollingResult.html":{"name":"PollingResult","abstract":"

    An events long polling result.

    "},"Classes/PollingURLInfo.html":{"name":"PollingURLInfo","abstract":"

    Polling URL info for requesting changes in event stream.

    "},"Classes/RecentItem.html":{"name":"RecentItem","abstract":"

    Item recently iteracted with

    "},"Classes/RetentionPolicy.html":{"name":"RetentionPolicy","abstract":"

    A retention policy blocks permanent deletion of content for a specified amount of time.

    "},"Classes/RetentionPolicyAssignment.html":{"name":"RetentionPolicyAssignment","abstract":"

    The retention policy assignment provides a way for admins to apply a retention policy on a per-folder basis,"},"Classes/RetentionPolicyAssignmentItem.html":{"name":"RetentionPolicyAssignmentItem","abstract":"

    The type and id of the content that is under retention.

    "},"Classes/RetentionPolicyEntry.html":{"name":"RetentionPolicyEntry","abstract":"

    Retention policy entry

    "},"Classes/Scope.html":{"name":"Scope","abstract":"

    Permission scope for a token.

    "},"Classes/SearchResult.html":{"name":"SearchResult","abstract":"

    Files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user.

    "},"Classes/SharedItem.html":{"name":"SharedItem","abstract":"

    Item shared by shared link.

    "},"Classes/SharedLink.html":{"name":"SharedLink","abstract":"

    Provides direct, read-only access to files or folder on Box using a URL

    "},"Classes/SignRequest.html":{"name":"SignRequest","abstract":"

    A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

    "},"Classes/SignRequestPrefillTag.html":{"name":"SignRequestPrefillTag","abstract":"

    Prefill tags are used to prefill placeholders with signer input data."},"Classes/SignRequestSignFiles.html":{"name":"SignRequestSignFiles","abstract":"

    List of files that will be signed, which are copies of the original source files."},"Classes/SignRequestSigner.html":{"name":"SignRequestSigner","abstract":"

    Represents a signer fields for GET Sign Request response.

    "},"Classes/SignRequestSignerDecision.html":{"name":"SignRequestSignerDecision","abstract":"

    Final decision made by the signer

    "},"Classes/SignRequestSignerInput.html":{"name":"SignRequestSignerInput","abstract":"

    Prefill tags are used to prefill placeholders with signer input data. Only none value field can be included.

    "},"Classes/StoragePolicy.html":{"name":"StoragePolicy","abstract":"

    Storage policy

    "},"Classes/StoragePolicyAssignment.html":{"name":"StoragePolicyAssignment","abstract":"

    Storage policy assignment

    "},"Classes/Task.html":{"name":"Task","abstract":"

    Enables file-centric workflows in Box. User can create tasks on files and assign them to collaborators on Box."},"Classes/TaskAssignment.html":{"name":"TaskAssignment","abstract":"

    Task assignment to a single user. There can be multiple assignments on a given task.

    "},"Classes/TermsOfService.html":{"name":"TermsOfService","abstract":"

    The Terms of Service allows Box Admins to configure a custom ToS indicating to users."},"Classes/TermsOfServiceUserStatus.html":{"name":"TermsOfServiceUserStatus","abstract":"

    Represents a Terms of Service status for a given user.

    "},"Classes/Token.html":{"name":"Token","abstract":"

    Embed link token

    "},"Classes/TokenInfo.html":{"name":"TokenInfo","abstract":"

    Info about the tokens used by the SDK for authentication.

    "},"Classes/TrackingCode.html":{"name":"TrackingCode","abstract":"

    Admin-defined information about a user

    "},"Classes/UploadPart.html":{"name":"UploadPart","abstract":"

    Object representing part of chunked upload.

    "},"Classes/UploadSession.html":{"name":"UploadSession","abstract":"

    Session object for chunked upload.

    "},"Classes/User.html":{"name":"User","abstract":"

    User of the Box application.

    "},"Classes/Watermark.html":{"name":"Watermark","abstract":"

    Watermark object labels folders and files to be protected by watermarks, which will show on file previews."},"Classes/WebLink.html":{"name":"WebLink","abstract":"

    Object that points to URLs. These objects are also known as bookmarks within the Box web application.

    "},"Classes/Webhook.html":{"name":"Webhook","abstract":"

    Defines a Webhook, which enables event triggers to be attached to Box files and folders

    "},"Classes/ZipDownload.html":{"name":"ZipDownload","abstract":"

    Defines a Zip Download

    "},"Classes/ZipDownloadConflict.html":{"name":"ZipDownloadConflict","abstract":"

    Defines a Zip Download Conflict

    "},"Classes/ZipDownloadConflictItem.html":{"name":"ZipDownloadConflictItem","abstract":"

    Defines a Zip Download Conflict Item

    "},"Classes/ZipDownloadStatus.html":{"name":"ZipDownloadStatus","abstract":"

    Status of a Zip download

    "},"Classes/DelegatedAuthSession.html":{"name":"DelegatedAuthSession","abstract":"

    An authorization session using JWT token

    "},"Classes/OAuth2Session.html":{"name":"OAuth2Session","abstract":"

    OAuth 2 Session

    "},"Classes/SingleTokenSession.html":{"name":"SingleTokenSession","abstract":"

    Developer session that only requires a developer token. Session will only work as long as the token is valid.

    "},"Classes/KeychainTokenStore.html":{"name":"KeychainTokenStore","abstract":"

    Token store that uses the Apple keychain

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/collaborations.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/collaborations.md index 9e841f70e..01c6bd7cd 100644 --- a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/collaborations.md +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/collaborations.md @@ -63,6 +63,8 @@ To add a collaborator to an item, call with the type and ID of the item, as well as the type and ID of the collaborator — a user or a group. A `role` for the collaborator must be specified, which will determine the permissions the collaborator receives on the item. +To collaborate a user, pass in a user id and the `.user` accessible by type. + ```swift client.collaborations.create( @@ -70,7 +72,27 @@ client.collaborations.create( itemId: "22222", role: .editor, accessibleBy: "33333", - accessibleByType: "user" + accessibleByType: .user +) { (result: Result) in + guard case let .success(collaboration) = result else { + print("Error creating collaboration") + return + } + + print("Collaboration successfully created") +} +``` + +To collaborate a group, pass in a group id and the `.group` accessible by type. + + +```swift +client.collaborations.create( + itemType: "folder", + itemId: "22222", + role: .editor, + accessibleBy: "44444", + accessibleByType: .group ) { (result: Result) in guard case let .success(collaboration) = result else { print("Error creating collaboration") @@ -148,4 +170,4 @@ iterator.next { result in } ``` -[get-pending-collaborations]: https://opensource.box.com/box-ios-sdk/Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC24listPendingForEnterprise6offset5limit6fields10completionySiSg_AISaySSGSgys6ResultOyAA14PagingIteratorCyAA13CollaborationCGAA0A8SDKErrorCGctF \ No newline at end of file +[get-pending-collaborations]: https://opensource.box.com/box-ios-sdk/Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC24listPendingForEnterprise6offset5limit6fields10completionySiSg_AISaySSGSgys6ResultOyAA14PagingIteratorCyAA13CollaborationCGAA0A8SDKErrorCGctF diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/sign_requests.md b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/sign_requests.md new file mode 100644 index 000000000..c780d762f --- /dev/null +++ b/docs/docsets/BoxSDK.docset/Contents/Resources/Documents/usage/sign_requests.md @@ -0,0 +1,159 @@ +Sign Requests +============= + +Sign Requests are used to request e-signatures on documents from signers. +A Sign Request can refer to one or more Box Files and can be sent to one or more Box Sign Request Signers. + + + + + - [Create Sign Request](#create-sign-request) + - [List Sign Requests](#list-sign-requests) + - [Get Sign Request by ID](#get-sign-request-by-id) + - [Cancel Sign Request by ID](#cancel-sign-request-by-id) + - [Resend Sign Request by ID](#resend-sign-request-by-id) + + + +Create Sign Request +-------------------- + +To create a sign request, call +[`client.signRequests.create(signers:sourceFiles:parentFolder:parameters:completion:)`][create-sign-request] + +You need to provide at least one file (from which the signing document will be created), at least one signer to receive the Sign Request and a destination folder. You should use [`SignRequestCreateSourceFile`][box-sign-request-file] +,[`SignRequestCreateSigner`][box-sign-request-signer] and [`SignRequestCreateParentFolder`][box-sign-request-folder] types to provide the necessary data. + + +```swift + +let signers = [SignRequestCreateSigner(email: "signer@mail.com", role: .approver)] +let sourceFiles = [SignRequestCreateSourceFile(id: "12345")] +let parentFolder = SignRequestCreateParentFolder(id: "234") + +client.signRequests.create(signers: signers, sourceFiles: sourceFiles, parentFolder: parentFolder) { (result: Result) in + guard case let .success(signRequest) = result else { + print("Error creating sign request") + return + } + + print("Sign request \(signRequest.id) was created") +} +``` + +[`create`][create-sign-request] method allows you to specify optional parameters using the [`SignRequestCreateParameters`][sign-request-create-params] +object. + +```swift + +let signers = [SignRequestCreateSigner(email: "signer@mail.com", role: .approver)] +let sourceFiles = [SignRequestCreateSourceFile(id: "12345", fileVersionId: "5")] +let parentFolder = SignRequestCreateParentFolder(id: "234") +let params = SignRequestCreateParameters( + isDocumentPreparationNeeded: true, + emailSubject: "Sign Request from Acme", + emailMessage: "Hello! Please sign the document below" +) + +client.signRequests.create(signers: signers, sourceFiles: sourceFiles, parentFolder: parentFolder) { (result: Result) in + guard case let .success(signRequest) = result else { + print("Error creating sign request") + return + } + + print("Sign request \(signRequest.id) was created") +} +``` + +If you set ```isDocumentPreparationNeeded``` flag to true, you need to visit ```prepareUrl``` before the Sign Request will be sent. + +[create-sign-request]: https://opensource.box.com/box-ios-sdk/Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC6create7signers11sourceFiles12parentFolder10parameters10completionySayAA0C19RequestCreateSignerVG_SayAA0cnO10SourceFileVGAA0cno6ParentK0VAA0cnO10ParametersVSgys6ResultOyAA0cN0CAA0A8SDKErrorCGctF +[box-sign-request-file]: https://opensource.box.com/box-ios-sdk/Structs/SignRequestCreateSourceFile.html +[box-sign-request-signer]: https://opensource.box.com/box-ios-sdk/Structs/SignRequestCreateSigner.html +[box-sign-request-folder]: https://opensource.box.com/box-ios-sdk/Structs/SignRequestCreateParentFolder.html +[sign-request-create-params]: https://opensource.box.com/box-ios-sdk/Structs/SignRequestCreateParameters.html + +List Sign Requests +------------------ + +To retrieve sign requests, call +[`client.signRequests.list(marker:limit:)`][list-sign-requests]. This method will return an iterator object, which is used to get the sign requests. + + +```swift +let iterator = client.signRequests.list() +iterator.next { results in + switch results { + case let .success(page): + for signRequest in page.entries { + print("Sign request \(signRequest.id)") + } + + case let .failure(error): + print(error) + } +} +``` + +[list-sign-requests]: https://opensource.box.com/box-ios-sdk/Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC4list6marker5limitAA14PagingIteratorCyAA0C7RequestCGSSSg_SiSgtF + +Get Sign Request by ID +---------------------- + +To retrieve information about a sign request, call +[`client.signRequests.getById(id:)`][get-sign-request-by-id] with the ID of the sign request. + + +```swift +client.signRequests.getById(id: "1234") { (result: Result) in + guard case let .success(signRequest) = result else { + print("Error getting sign request") + return + } + + print("Sign request \(signRequest.id)") +} +``` + +[get-sign-request-by-id]: https://opensource.box.com/box-ios-sdk/Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC7getById2id10completionySS_ys6ResultOyAA0C7RequestCAA0A8SDKErrorCGctF + +Cancel Sign Request by ID +------------------------- + +To cancel a created sign request, call +[`client.signRequests.cancelById(id:, completion:)`][cancel-sign-request-by-id] + + +```swift +client.signRequests.cancelById(id: "1234") { (result: Result) in + guard case let .success(signRequest) = result else { + print("Error cancelling sign request") + return + } + + print("Sign request \(signRequest.id) is cancelled") +} +``` + +[cancel-sign-request-by-id]: https://opensource.box.com/box-ios-sdk/Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC10cancelById2id10completionySS_ys6ResultOyAA0C7RequestCAA0A8SDKErrorCGctF + +Resend Sign Request by ID +------------- + +To resend a sign request to all signers that have not signed it yet, call +[`client.signRequests.resendById(id:, completion:)`][resend-sign-request-by-id]. +There is an 10-minute cooling-off period between re-sending reminder emails. If this method is called during the cooling-off period, a BoxAPIError will be thrown. + + +```swift +client.signRequests.resendById(id: "1234") { result: Result} in + guard case .success = result else { + print("Error resending sign request") + return + } + + print("Sign request successfully resent") +} +``` + +[resend-sign-request-by-id]: https://opensource.box.com/box-ios-sdk/Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC10resendById2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF \ No newline at end of file diff --git a/docs/docsets/BoxSDK.docset/Contents/Resources/docSet.dsidx b/docs/docsets/BoxSDK.docset/Contents/Resources/docSet.dsidx index 4abfd7b7a..989e837f9 100644 Binary files a/docs/docsets/BoxSDK.docset/Contents/Resources/docSet.dsidx and b/docs/docsets/BoxSDK.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/docsets/BoxSDK.tgz b/docs/docsets/BoxSDK.tgz index 2f8c70db3..a64046970 100644 Binary files a/docs/docsets/BoxSDK.tgz and b/docs/docsets/BoxSDK.tgz differ diff --git a/docs/index.html b/docs/index.html index 3c9d37f45..b3368896e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -16,18 +16,18 @@
    -

    BoxSDK 4.4.0 Docs (100% documented)

    -

    +

    BoxSDK 5.0.0 Docs (100% documented)

    +
    -

    +
    @@ -340,6 +340,27 @@ + + + + + + + @@ -555,6 +576,18 @@ + + + + @@ -714,6 +747,21 @@ + + + + + @@ -760,6 +808,8 @@

    Box iOS SDK

    License Swift Package Manager Carthage compatible CocoaPods compatible Build Status Coverage Status

    + +

    Getting Started Docs: https://developer.box.com/guides/mobile/ios/quick-start/

    NOTE:

    The Box iOS SDK in Objective-C (prior to v3.0.0) has been moved from the main branch to the objective-c-maintenance branch. @@ -768,23 +818,37 @@

    NOTE:

    Box iOS SDK

  • Release Definitions
  • +
  • Release Candidate (RC)
  • +
  • Current Release
  • +
  • Long Term Support
  • +
  • Support Phases + +
  • Copyright and License
  • + @@ -798,22 +862,20 @@

    Installing the SDK

    Carthage

    Step 1: Add to your Cartfile

    -
    git "https://github.com/box/box-ios-sdk.git" ~> 4.0
    +
    git "https://github.com/box/box-ios-sdk.git" ~> 5.0
     

    Step 2: Update dependencies

    -
    $ carthage update --platform iOS
    +
    $ carthage update --use-xcframeworks --platform iOS
     
    -

    If you are using Xcode 12, you must follow the steps outlined here to install dependecies due to a bug in carthage.

    - -

    Step 3: Drag the built framework from Carthage/Build/iOS into your project.

    +

    Step 3: Drag the built xcframework from Carthage/Build into your project.

    For more detailed instructions, please see the official documentation for Carthage.

    CocoaPods

    Step 1: Add to your Podfile

    -
    pod 'BoxSDK', '~> 4.0'
    +
    pod 'BoxSDK', '~> 5.0'
     

    Step 2: Install pod by running the following command in the directory with the Podfile

    @@ -867,12 +929,12 @@

    OAuth2 Sample App

    To execute the sample app:

    Step 1: Run carthage

    -
    $ cd SampleApps/OAuth2SampleApp
    -$ carthage update --platform iOS
    +
    $ cd SampleApps/OAuth2SampleApp
    +$ carthage update --use-xcframeworks --platform iOS
     

    Step 2: Open Xcode Project File

    -
    $ open OAuth2SampleApp.xcodeproj
    +
    $ open OAuth2SampleApp.xcodeproj
     

    Step 3: Insert your client ID and client secret

    @@ -900,12 +962,12 @@

    JWT Auth Sample App

    To execute the sample app:

    Step 1: Run carthage

    -
    $ cd SampleApps/JWTSampleApp
    -$ carthage update --platform iOS
    +
    $ cd SampleApps/JWTSampleApp
    +$ carthage update --use-xcframeworks --platform iOS
     

    Step 2: Open Xcode Project File

    -
    $ open JWTSampleApp.xcodeproj
    +
    $ open JWTSampleApp.xcodeproj
     

    Step 3: Insert your client ID and client secret

    @@ -1030,11 +1092,10 @@ - diff --git a/docs/js/jazzy.js b/docs/js/jazzy.js index 1e55d6ef0..198441660 100755 --- a/docs/js/jazzy.js +++ b/docs/js/jazzy.js @@ -1,3 +1,7 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + window.jazzy = {'docset': false} if (typeof window.dash != 'undefined') { document.documentElement.className += ' dash' diff --git a/docs/js/jazzy.search.js b/docs/js/jazzy.search.js index e3d1ab905..359cdbb8b 100644 --- a/docs/js/jazzy.search.js +++ b/docs/js/jazzy.search.js @@ -1,3 +1,7 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + $(function(){ var $typeahead = $('[data-typeahead]'); var $form = $typeahead.parents('form'); diff --git a/docs/js/jquery.min.js b/docs/js/jquery.min.js index b0614034a..c4c6022f2 100644 --- a/docs/js/jquery.min.js +++ b/docs/js/jquery.min.js @@ -1,2 +1,2 @@ -/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); +!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.9",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return void 0===e||null===e?"":e.toString()},e.utils.clone=function(e){if(null===e||void 0===e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i0){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docs/search.json b/docs/search.json index a73f5b1b4..df6cc4f18 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:6BoxSDK8Callbacka":{"name":"Callback","abstract":"

    Closure to return any generic type or an BoxSDKError"},"Typealiases.html#/s:6BoxSDK16TokenInfoClosurea":{"name":"TokenInfoClosure","abstract":"

    Closure returning either standard TokenInfo object or error."},"Typealiases.html#/s:6BoxSDK15QueryParametersa":{"name":"QueryParameters","abstract":"

    Represents API request query parameters.

    "},"Typealiases.html#/s:6BoxSDK0A11HTTPHeadersa":{"name":"BoxHTTPHeaders","abstract":"

    Represents HTTP headers for API requests.

    "},"Typealiases.html#/s:6BoxSDK16AccessTokenTuplea":{"name":"AccessTokenTuple","abstract":"

    Contains access token and its expiration date.

    "},"Typealiases.html#/s:6BoxSDK20DelegatedAuthClosurea":{"name":"DelegatedAuthClosure","abstract":"

    Contains unique ID as an identifier for JWT token provider and completion returning either valid access token information or an error.

    "},"Typealiases.html#/s:6BoxSDK18AccessTokenClosurea":{"name":"AccessTokenClosure","abstract":"

    Closure returning either access token string or error."},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV2idSSvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"ZipDownloadItem"},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV4typeSSvp":{"name":"type","abstract":"

    Box item type - should be file or folder.

    ","parent_name":"ZipDownloadItem"},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV2id4typeACSS_SStcfc":{"name":"init(id:type:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadItem"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV6partIdSSvp":{"name":"partId","abstract":"

    Part Id

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV6offsetSivp":{"name":"offset","abstract":"

    Part offset

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4sizeSivp":{"name":"size","abstract":"

    Part size

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4sha1SSSgvp":{"name":"sha1","abstract":"

    Part SHA hash

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    The upload part description’s raw data

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV18jsonRepresentationSDySSypGyF":{"name":"jsonRepresentation()","abstract":"

    Get the upload part description in JSON

    ","parent_name":"UploadPartDescription"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5fieldSSvp":{"name":"field","abstract":"

    The field to match against.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5valueSSvp":{"name":"value","abstract":"

    The value to match against.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5field5valueACSS_SStcfc":{"name":"init(field:value:)","abstract":"

    Initializer.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV2idSSSgvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV4typeSSSgvp":{"name":"type","abstract":"

    The data type of the field’s value.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV3keySSSgvp":{"name":"key","abstract":"

    A unique identifier for the field. The identifier must be unique within the template to which it belongs.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV11displayNameSSSgvp":{"name":"displayName","abstract":"

    The display name of the field.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the field.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV7optionsSaySDyS2SGGSgvp":{"name":"options","abstract":"

    For type enum, a list of all possible value

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV6hiddenSbSgvp":{"name":"hidden","abstract":"

    Whether this template is hidden in the UI

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV2id4type3key11displayName11description7options6hiddenACSSSg_A4KSaySDyS2SGGSgSbSgtcfc":{"name":"init(id:type:key:displayName:description:options:hidden:)","abstract":"

    Initializer.

    ","parent_name":"MetadataField"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO4noneyA2EmF":{"name":"none","abstract":"

    Generating the representation needs to be manually triggered (see info.url note).

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO7pendingyA2EmF":{"name":"pending","abstract":"

    Content is being generated but is not ready yet.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO8viewableyA2EmF":{"name":"viewable","abstract":"

    Similar to pending, though indicates that enough content is available to be useful.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO7successyA2EmF":{"name":"success","abstract":"

    All of the content is available and complete.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO5erroryA2EmF":{"name":"error","abstract":"

    An error happened and this content is not available.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    A custom value not implemented in this version of SDK.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"StatusEnum"},"Structs/FileRepresentation/Status.html#/s:6BoxSDK18FileRepresentationV6StatusV5stateAC0E4EnumOSgvp":{"name":"state","abstract":"

    State describing the status

    ","parent_name":"Status"},"Structs/FileRepresentation/Info.html#/s:6BoxSDK18FileRepresentationV4InfoV3urlSSSgvp":{"name":"url","abstract":"

    An opaque URL which will return status information about the file.

    ","parent_name":"Info"},"Structs/FileRepresentation/Content.html#/s:6BoxSDK18FileRepresentationV7ContentV11urlTemplateSSSgvp":{"name":"urlTemplate","abstract":"

    An opaque URL template to the content.

    ","parent_name":"Content"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV7contentAC7ContentVSgvp":{"name":"content","abstract":"

    An opaque URL template to the content.

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV4infoAC4InfoVSgvp":{"name":"info","abstract":"

    An opaque URL which will return status information about the file.

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV10propertiesSDyS2SGvp":{"name":"properties","abstract":"

    A set of static properties to distinguish between subtypes of a given representation,","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV6statusAC6StatusVSgvp":{"name":"status","abstract":"

    Status string

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV14representationSSSgvp":{"name":"representation","abstract":"

    Usually the extension of the format, but occasionally a name of a standard (potentially de facto)","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Content.html":{"name":"Content","abstract":"

    Contains an opaque URL template to the content, which follows RFC 6570.","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Info.html":{"name":"Info","abstract":"

    Contains an opaque URL which will return status information about the file.","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Status.html":{"name":"Status","abstract":"

    Defines the current status of the file representation generation

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation/StatusEnum.html":{"name":"StatusEnum","abstract":"

    A string with one of the following values: ‘none’, ‘pending’, ‘viewable’, ‘error’ and ‘success’.

    ","parent_name":"FileRepresentation"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV10statusCodeSiSgvp":{"name":"statusCode","abstract":"

    The HTTP status code of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV7headersSDyS2SGSgvp":{"name":"headers","abstract":"

    The HTTP headers of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV4bodySDySSypGSgvp":{"name":"body","abstract":"

    The body component of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV6methodSSvp":{"name":"method","abstract":"

    The HTTP method for the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV3urlAA0A13URLComponentsVvp":{"name":"url","abstract":"

    The URL the BoxRequest is sent to

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV7headersSDyS2SGvp":{"name":"headers","abstract":"

    The HTTP headers sent in the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV4bodySSSgvp":{"name":"body","abstract":"

    The optional body of the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV6schemeSSSgvp":{"name":"scheme","abstract":"

    URL scheme information

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV4hostSSSgvp":{"name":"host","abstract":"

    URL host information

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV4pathSSSgvp":{"name":"path","abstract":"

    URL path

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV5querySDyS2SGSgvp":{"name":"query","abstract":"

    Optional URL query parameters

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV8fragmentSSSgvp":{"name":"fragment","abstract":"

    Optional page reference / anchor

    ","parent_name":"BoxURLComponents"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV6accessAA0cD6AccessOSgvp":{"name":"access","abstract":"

    The access level for the shared link. Can be open (“People with the link”),","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV8passwordAA17NullableParameterOySSGSgvp":{"name":"password","abstract":"

    The password required to access the shared link.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV10unsharedAtAA17NullableParameterOy10Foundation4DateVGSgvp":{"name":"unsharedAt","abstract":"

    The date-time that this link will become disabled.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV11permissionsSDySSSbGSgvp":{"name":"permissions","abstract":"

    Whether the shared link allows downloads and previews.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV6access8password10unsharedAt11canDownloadAcA0cD6AccessOSg_AA17NullableParameterOySSGSgALy10Foundation4DateVGSgSbSgtcfc":{"name":"init(access:password:unsharedAt:canDownload:)","abstract":"

    Initializer.

    ","parent_name":"SharedLinkData"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormVACycfc":{"name":"init()","abstract":"

    Initialize an empty form.

    ","parent_name":"MultipartForm"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormV10appendPart4name8contentsySS_10Foundation4DataVtF":{"name":"appendPart(name:contents:)","abstract":"

    Append a body part to the form.

    ","parent_name":"MultipartForm"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormV14appendFilePart4name8contents6length8fileName8mimeTypeySS_So13NSInputStreamCSiS2StF":{"name":"appendFilePart(name:contents:length:fileName:mimeType:)","abstract":"

    Append a file body part to the form.

    ","parent_name":"MultipartForm"},"Structs/LockData.html#/s:6BoxSDK8LockDataV9expiresAt19isDownloadPreventedAC10Foundation4DateVSg_SbSgtcfc":{"name":"init(expiresAt:isDownloadPrevented:)","abstract":"

    Initializer.

    ","parent_name":"LockData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV13canRunReportsSbSgvp":{"name":"canRunReports","abstract":"

    Whether the user can run reports.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV15canInstantLoginSbSgvp":{"name":"canInstantLogin","abstract":"

    Whether the user can instant login.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV17canCreateAccountsSbSgvp":{"name":"canCreateAccounts","abstract":"

    Whether the user can create other accounts.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV15canEditAccountsSbSgvp":{"name":"canEditAccounts","abstract":"

    Whether the user can edit accounts.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV13canRunReports0F12InstantLogin0F14CreateAccounts0f4EditL0ACSbSg_A3Htcfc":{"name":"init(canRunReports:canInstantLogin:canCreateAccounts:canEditAccounts:)","abstract":"

    Initializer.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ClientAnalyticsInfo.html#/s:6BoxSDK19ClientAnalyticsInfoV7appName0F7VersionACSS_SStcfc":{"name":"init(appName:appVersion:)","abstract":"

    Initializer

    ","parent_name":"ClientAnalyticsInfo"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV8clientIdSSvp":{"name":"clientId","abstract":"

    The client ID of the application requesting authentication. To get the client ID for your application,","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV12clientSecretSSvp":{"name":"clientSecret","abstract":"

    The client secret of the application requesting authentication. To get the client secret for your application,","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV10apiBaseURL10Foundation0F0Vvp":{"name":"apiBaseURL","abstract":"

    Base URL for majority of the requests.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV16uploadApiBaseURL10Foundation0G0Vvp":{"name":"uploadApiBaseURL","abstract":"

    Base URL for file upload requests.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV18oauth2AuthorizeURL10Foundation0F0Vvp":{"name":"oauth2AuthorizeURL","abstract":"

    URL for the OAuth2 authorization page, where users are redirected to enter their credentials

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV16maxRetryAttemptsSivp":{"name":"maxRetryAttempts","abstract":"

    Maximum number of retries for a failed request.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV21tokenRefreshThresholdSdvp":{"name":"tokenRefreshThreshold","abstract":"

    Specifies how long before token expiration date it should be refreshed.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV17retryBaseIntervalSdvp":{"name":"retryBaseInterval","abstract":"

    The base factor used in calculating exponential backoff delay for retries

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV19clientAnalyticsInfoAA06ClienteF0VSgvp":{"name":"clientAnalyticsInfo","abstract":"

    Analytics info that is set to request headers.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV21consoleLogDestinationAA07ConsoleeF0Cvp":{"name":"consoleLogDestination","abstract":"

    Console log destination.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV18fileLogDestinationAA04FileeF0CSgvp":{"name":"fileLogDestination","abstract":"

    File log destination.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV11callbackURLSSvp":{"name":"callbackURL","abstract":"

    An optional custom callback URL string. The URL to which Box redirects the browser when authentication completes.","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html":{"name":"BoxSDKConfiguration","abstract":"

    SDK configuration specifying request related information

    "},"Structs/ClientAnalyticsInfo.html":{"name":"ClientAnalyticsInfo","abstract":"

    Analytics info about the app using the SDK.

    "},"Structs/ConfigurablePermissionData.html":{"name":"ConfigurablePermissionData","abstract":"

    Defines configurable permission data for creating and updating group membership."},"Structs/LockData.html":{"name":"LockData","abstract":"

    Defines a lock on a Box item

    "},"Structs/MultipartForm.html":{"name":"MultipartForm","abstract":"

    Representation of a multipart form request body.

    "},"Structs/SharedLinkData.html":{"name":"SharedLinkData","abstract":"

    Defines shared link data for updating file information."},"Structs/BoxURLComponents.html":{"name":"BoxURLComponents","abstract":"

    The components that make up a URL

    "},"Structs/BoxRequestDescription.html":{"name":"BoxRequestDescription","abstract":"

    The components that make up a description of a BoxRequest

    "},"Structs.html#/s:6BoxSDK0A8ResponseV":{"name":"BoxResponse","abstract":"

    Box API request response

    "},"Structs/BoxResponseDescription.html":{"name":"BoxResponseDescription","abstract":"

    The components that make up a description of a BoxResponse

    "},"Structs/FileRepresentation.html":{"name":"FileRepresentation","abstract":"

    Digital assets created for files stored in Box.

    "},"Structs/MetadataField.html":{"name":"MetadataField","abstract":"

    A field in a metadata template.

    "},"Structs/MetadataFieldFilter.html":{"name":"MetadataFieldFilter","abstract":"

    Filter for matching against a metadata field

    "},"Structs/UploadPartDescription.html":{"name":"UploadPartDescription","abstract":"

    Description of uploaded part

    "},"Structs/ZipDownloadItem.html":{"name":"ZipDownloadItem","abstract":"

    Item field for creating a Zip download.

    "},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP4read10completionyys6ResultOyAA0C4InfoCs5Error_pGc_tF":{"name":"read(completion:)","abstract":"

    Retrieves current token information

    ","parent_name":"TokenStore"},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP5write9tokenInfo10completionyAA0cG0C_ys6ResultOyyts5Error_pGctF":{"name":"write(tokenInfo:completion:)","abstract":"

    Sets new token data

    ","parent_name":"TokenStore"},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP5clear10completionyys6ResultOyyts5Error_pGc_tF":{"name":"clear(completion:)","abstract":"

    Removes a token

    ","parent_name":"TokenStore"},"Protocols/ExpiredTokenHandling.html#/s:6BoxSDK20ExpiredTokenHandlingP06handlecD010completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"handleExpiredToken(completion:)","abstract":"

    Handles token expiration.

    ","parent_name":"ExpiredTokenHandling"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","abstract":"

    Gets access token

    ","parent_name":"SessionProtocol"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","abstract":"

    Revokes all the tokens

    ","parent_name":"SessionProtocol"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP14downscopeToken5scope8resource10sharedLink10completionyShyAA0F5ScopeOG_SSSgALys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"SessionProtocol"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    Raw data from the API that populates the model

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonx10Foundation4DataV_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonSSyF":{"name":"json()","abstract":"

    Gets JSON string for a Box model object.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelPAAE12toJSONStringSSyF":{"name":"toJSONString()","abstract":"

    Gets JSON string for a Box model object.

    ","parent_name":"BoxModel"},"Protocols/QueryParameterConvertible.html#/s:6BoxSDK25QueryParameterConvertibleP15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"QueryParameterConvertible"},"Protocols/NetworkAgentProtocol.html#/s:6BoxSDK20NetworkAgentProtocolP4send7request10completionyAA0A7RequestC_ys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"send(request:completion:)","abstract":"

    Makes a Box SDK request

    ","parent_name":"NetworkAgentProtocol"},"Protocols/TokenRefreshing.html#/s:6BoxSDK15TokenRefreshingP7refresh0eC010completionySS_ys6ResultOyAA0C4InfoCAA0A8SDKErrorCGctF":{"name":"refresh(refreshToken:completion:)","abstract":"

    Refreshes a token.

    ","parent_name":"TokenRefreshing"},"Protocols/TokenRefreshing.html#/s:6BoxSDK15TokenRefreshingP03getC08withCode10completionySS_ys6ResultOyAA0C4InfoCAA0A8SDKErrorCGctF":{"name":"getToken(withCode:completion:)","abstract":"

    Exchange an authorization code for an access token

    ","parent_name":"TokenRefreshing"},"Protocols/LogDestination.html#/s:6BoxSDK14LogDestinationP5write_5level8category_ys12StaticStringV_AA0C5LevelOAA0C8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message

    ","parent_name":"LogDestination"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE2eeoiySbx_SStFZ":{"name":"==(_:_:)","abstract":"

    Compare equality between enum and string

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE2eeoiySbSS_xtFZ":{"name":"==(_:_:)","abstract":"

    Compare equality between string and enum

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

    Encode the enum to a JSON string

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

    Initialization using decoder

    ","parent_name":"BoxEnum"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3get3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"get(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP GET method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP4post3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP4post3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters4data8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAM4DataVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:data:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response - variant for chunked upload.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP7options3url11httpHeaders15queryParameters4json10completionAA0A11NetworkTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"options(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP OPTIONS method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP6delete3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"delete(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP DELETE method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html":{"name":"BoxClientProtocol","abstract":"

    Defines methods for communication with Box APIs

    "},"Protocols/BoxEnum.html":{"name":"BoxEnum","abstract":"

    General BoxEnum protocol specifying response model enum behaviour

    "},"Protocols/LogDestination.html":{"name":"LogDestination","abstract":"

    Defines main log destination behaviour

    "},"Protocols/TokenRefreshing.html":{"name":"TokenRefreshing","abstract":"

    Defines methods for Token refreshing.

    "},"Protocols/NetworkAgentProtocol.html":{"name":"NetworkAgentProtocol","abstract":"

    Defines networking layer interface

    "},"Protocols/QueryParameterConvertible.html":{"name":"QueryParameterConvertible","abstract":"

    Defines items convertible to query parameter

    "},"Protocols/BoxModel.html":{"name":"BoxModel","abstract":"

    Defines Box SDK model behavior

    "},"Protocols.html#/s:6BoxSDK0A10InnerModelP":{"name":"BoxInnerModel","abstract":"

    Box inner model

    "},"Protocols/SessionProtocol.html":{"name":"SessionProtocol","abstract":"

    Defines methods for managing session token.

    "},"Protocols/ExpiredTokenHandling.html":{"name":"ExpiredTokenHandling","abstract":"

    Defines handler for expired token.

    "},"Protocols/TokenStore.html":{"name":"TokenStore","abstract":"

    Defines an interface for managing token.

    "},"Extensions/Optional.html#/s:Sq6BoxSDKAA25QueryParameterConvertibleRzlE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Optional"},"Extensions/Array.html#/s:Sa6BoxSDKSyRzlE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Array"},"Extensions/NSString.html#/s:So8NSStringC6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"NSString"},"Extensions/NSNumber.html#/s:So8NSNumberC6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"NSNumber"},"Extensions/Bool.html#/s:Sb6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Bool"},"Extensions/Int.html#/s:Si6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Int"},"Extensions/String.html#/s:SS6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"String"},"Extensions/String.html":{"name":"String"},"Extensions/Int.html":{"name":"Int"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/NSNumber.html":{"name":"NSNumber"},"Extensions/NSString.html":{"name":"NSString"},"Extensions/Array.html":{"name":"Array"},"Extensions/Optional.html":{"name":"Optional"},"Enums/WebhookItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO6folderyAcA6FolderCcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"WebhookItem"},"Enums/TaskItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:6BoxSDK8TaskItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File with task assignment.

    ","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:6BoxSDK8TaskItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"TaskItem"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO9completedyA2CmF":{"name":"completed","abstract":"

    Completed

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO10incompleteyA2CmF":{"name":"incomplete","abstract":"

    Incomplete

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO8approvedyA2CmF":{"name":"approved","abstract":"

    Approved

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Rejected

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not implemented in this version of SDK.

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AssignmentState"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO9completedyA2CmF":{"name":"completed","abstract":"

    Completed

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO10incompleteyA2CmF":{"name":"incomplete","abstract":"

    Incomplete

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO8approvedyA2CmF":{"name":"approved","abstract":"

    Approved

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Rejected

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not implemented in this version of SDK.

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AssignmentStatus"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO6reviewyA2CmF":{"name":"review","abstract":"

    Approval task that can be approved or rejected

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO8completeyA2CmF":{"name":"complete","abstract":"

    General task which can be completed

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom task action

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"TaskAction"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO12allAssigneesyA2CmF":{"name":"allAssignees","abstract":"

    Task is complete when all assignees complete it

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11anyAssigneeyA2CmF":{"name":"anyAssignee","abstract":"

    Task is complete when any assignees complete it

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"TaskCompletionRule"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO4openyA2CmF":{"name":"open","abstract":"

    Anyone with the link can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO7companyyA2CmF":{"name":"company","abstract":"

    People in your company can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO13collaboratorsyA2CmF":{"name":"collaborators","abstract":"

    People in this folder can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented by the SDK

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SharedLinkAccess"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO14annotationEdityA2CmF":{"name":"annotationEdit","abstract":"

    Allow user to edit annotations (delete).

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO17annotationViewAllyA2CmF":{"name":"annotationViewAll","abstract":"

    Allows user to view all users’ annotations.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO18annotationViewSelfyA2CmF":{"name":"annotationViewSelf","abstract":"

    Allows user to view their own annotations only.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO12baseExploreryA2CmF":{"name":"baseExplorer","abstract":"

    Allows access to content in the folder tree based on user/file/token permissions.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10basePickeryA2CmF":{"name":"basePicker","abstract":"

    Allows access to content in the folder tree based on user/file/token permissions.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11basePreviewyA2CmF":{"name":"basePreview","abstract":"

    Allows the user to preview the file, nothing else.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11baseSidebaryA2CmF":{"name":"baseSidebar","abstract":"

    Allows the user to get basic file info needed for the sidebar.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10baseUploadyA2CmF":{"name":"baseUpload","abstract":"

    Allows upload into the folder specific under “resource” of the Token Exchange request.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemDeleteyA2CmF":{"name":"itemDelete","abstract":"

    Allows file/folders to be deleted.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO12itemDownloadyA2CmF":{"name":"itemDownload","abstract":"

    Allows files/folders contents to be downloaded.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11itemPreviewyA2CmF":{"name":"itemPreview","abstract":"

    Automatically enables preview of the file, upon user click (requires Preview UI Element to be referenced).

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemRenameyA2CmF":{"name":"itemRename","abstract":"

    Allows files/folders to be renamed.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO9itemShareyA2CmF":{"name":"itemShare","abstract":"

    Allows sharing of resource specified under “resource” of the Token Exchange request.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemUploadyA2CmF":{"name":"itemUpload","abstract":"

    Allows upload in the content picker.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom permission that was not yet implemented in this version of SDK.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of token scope

    ","parent_name":"TokenScope"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO6folderyA2CmF":{"name":"folder","abstract":"

    Folder type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    Enterprise type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO16metadataTemplateyA2CmF":{"name":"metadataTemplate","abstract":"

    Metadata template type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this version of SDK.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO6activeyA2CmF":{"name":"active","abstract":"

    Retention policy is active.

    ","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO7retiredyA2CmF":{"name":"retired","abstract":"

    Retention policy is retired. Can be only retired by administrator","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value that was not yet implemented in current SDK version.

    ","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyStatus"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO17permanentlyDeleteyA2CmF":{"name":"permanentlyDelete","abstract":"

    Content retained by the policy to be permanently deleted once the retention policy time period has passed.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO15removeRetentionyA2CmF":{"name":"removeRetention","abstract":"

    Will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy time period has passed.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in the SDK.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"DispositionAction"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO6finiteyA2CmF":{"name":"finite","abstract":"

    A specific amount of time to retain the content is known upfront.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO10indefiniteyA2CmF":{"name":"indefinite","abstract":"

    The amount of time to retain the content is still unknown.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this SDK version.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyType"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO13addEnumOptionyACSS_SDySSypGtcACmF":{"name":"addEnumOption(fieldKey:data:)","abstract":"

    Adds an enum option at the end of the enum option list for the specified field.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO8addFieldyACSDySSypG_tcACmF":{"name":"addField(data:)","abstract":"

    Adds a field at the end of the field list for the template.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO04editD0yACSDySSypG_tcACmF":{"name":"editTemplate(data:)","abstract":"

    Edits any number of the base properties of a template: displayName, hidden.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO18reorderEnumOptionsyACSS_SaySSGtcACmF":{"name":"reorderEnumOptions(fieldKey:enumOptionKeys:)","abstract":"

    Reorders the enum option list to match the requested enum option list.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO13reorderFieldsyACSaySSG_tcACmF":{"name":"reorderFields(fieldKeys:)","abstract":"

    Reorders the field list to match the requested field list

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO9editFieldyACSS_SDySSypGtcACmF":{"name":"editField(fieldKey:data:)","abstract":"

    Edits any number of the base properties of a field: displayName, hidden, description, key.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO14editEnumOptionyACSS_SDySSypGSStcACmF":{"name":"editEnumOption(fieldKey:data:enumOptionKey:)","abstract":"

    Edits the enumOption.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO16removeEnumOptionyACSS_SStcACmF":{"name":"removeEnumOption(fieldKey:enumOptionKey:)","abstract":"

    Removes the specified enum option from the specified enum field.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO11removeFieldyACSS_tcACmF":{"name":"removeField(fieldKey:)","abstract":"

    Removes the specified field from the template

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an option.

    ","parent_name":"MetadataTemplateOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO3addyACSS_SStcACmF":{"name":"add(path:value:)","abstract":"

    Adds new metadata path/value pair

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO7replaceyACSS_SStcACmF":{"name":"replace(path:value:)","abstract":"

    Replaces metadata for path with a new value

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO4testyACSS_SStcACmF":{"name":"test(path:value:)","abstract":"

    Tests expected metadata value for given path

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO6removeyACSS_tcACmF":{"name":"remove(path:)","abstract":"

    Removes metadata for given path

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an operation option.

    ","parent_name":"FolderMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO3addyACSS_SStcACmF":{"name":"add(path:value:)","abstract":"

    Adds new metadata path/value pair

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO7replaceyACSS_SStcACmF":{"name":"replace(path:value:)","abstract":"

    Replaces metadata for path with a new value

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4testyACSS_SStcACmF":{"name":"test(path:value:)","abstract":"

    Tests expected metadata value for given path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO6removeyACSS_tcACmF":{"name":"remove(path:)","abstract":"

    Removes metadata for given path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4moveyACSS_SStcACmF":{"name":"move(from:path:)","abstract":"

    Moves metadata from original path to new path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4copyyACSS_SStcACmF":{"name":"copy(from:path:)","abstract":"

    Copies metadata from original path to new path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an operation option.

    ","parent_name":"FileMetadataOperation"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO6memberyA2CmF":{"name":"member","abstract":"

    Default permission for a user in a Group.

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO5adminyA2CmF":{"name":"admin","abstract":"

    The admin of the Group.

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access that is not yet implemented

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"GroupRole"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO10adminsOnlyyA2CmF":{"name":"adminsOnly","abstract":"

    Main Admin, Coadmins and group’s Group Admin can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO16adminsAndMembersyA2CmF":{"name":"adminsAndMembers","abstract":"

    Admins and group members can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO15allManagedUsersyA2CmF":{"name":"allManagedUsers","abstract":"

    All managed users in the enterprise can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom level that was not yet implemented in this version of SDK.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO11descriptionSSvp":{"name":"description","abstract":"

    String representation of member viewability level

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO10adminsOnlyyA2CmF":{"name":"adminsOnly","abstract":"

    Main Admin, Co-admins, the group’s Group Admin can invite

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO16adminsAndMembersyA2CmF":{"name":"adminsAndMembers","abstract":"

    Admins and group members can invite

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO15allManagedUsersyA2CmF":{"name":"allManagedUsers","abstract":"

    All managed users in the enterprise.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom level that was not yet implemented in this version of SDK.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO11descriptionSSvp":{"name":"description","abstract":"

    String representation of invitability level.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/FolderItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO6folderyAcA0C0CcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO7webLinkyAcA03WebF0CcACmF":{"name":"webLink(_:)","abstract":"

    Weblink type pointing to either a file or folder.

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Item debug description.

    ","parent_name":"FolderItem"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO11descriptionSSvp":{"name":"description","abstract":"

    String representation of sync state.

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO6syncedyA2CmF":{"name":"synced","abstract":"

    Folder will be synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO9notSyncedyA2CmF":{"name":"notSynced","abstract":"

    Folder will not be synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO15partiallySyncedyA2CmF":{"name":"partiallySynced","abstract":"

    Folder is partially synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom sync option, that is not yet implemented in this SDK version.

    ","parent_name":"SyncState"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO3pdfyA2CmF":{"name":"pdf","abstract":"

    The PDF representation

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO9thumbnailyA2CmF":{"name":"thumbnail","abstract":"

    Thumbnail image with resolution 320x320px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO11imageMediumyA2CmF":{"name":"imageMedium","abstract":"

    Image with resolution 1024x1024px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO10imageLargeyA2CmF":{"name":"imageLarge","abstract":"

    Image with resolution 2048x2048px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO13extractedTextyA2CmF":{"name":"extractedText","abstract":"

    Extracted text from original document.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    It is possible to use a custom value. See representations documentation.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"FileRepresentationHint"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemCreatedyA2CmF":{"name":"itemCreated","abstract":"

    A folder or file was created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12itemUploadedyA2CmF":{"name":"itemUploaded","abstract":"

    A folder or file was uploaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14commentCreatedyA2CmF":{"name":"commentCreated","abstract":"

    A comment was created on a folder, file, or other comment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14commentDeletedyA2CmF":{"name":"commentDeleted","abstract":"

    A comment was deleted on folder, file, or other comment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14itemDownloadedyA2CmF":{"name":"itemDownloaded","abstract":"

    A file or folder was downloaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13itemPreviewedyA2CmF":{"name":"itemPreviewed","abstract":"

    A file was previewed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9itemMovedyA2CmF":{"name":"itemMoved","abstract":"

    A file or folder was moved.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemCopiedyA2CmF":{"name":"itemCopied","abstract":"

    A file or folder was copied.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12taskAssignedyA2CmF":{"name":"taskAssigned","abstract":"

    A task was assigned.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11taskCreatedyA2CmF":{"name":"taskCreated","abstract":"

    A task was created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10fileLockedyA2CmF":{"name":"fileLocked","abstract":"

    A file was locked.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12fileUnlockedyA2CmF":{"name":"fileUnlocked","abstract":"

    A file was unlocked. If a locked file is deleted, the source file will be null.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemDeletedyA2CmF":{"name":"itemDeleted","abstract":"

    A file or folder was marked as deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13itemRecoveredyA2CmF":{"name":"itemRecovered","abstract":"

    A file or folder was recovered out of the trash.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17collaboratorAddedyA2CmF":{"name":"collaboratorAdded","abstract":"

    A collaborator was added to a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23collaboratorRoleChangedyA2CmF":{"name":"collaboratorRoleChanged","abstract":"

    A collaborator had their role changed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19collaboratorInvitedyA2CmF":{"name":"collaboratorInvited","abstract":"

    A collaborator was invited on a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19collaboratorRemovedyA2CmF":{"name":"collaboratorRemoved","abstract":"

    A collaborator was removed from a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8itemSyncyA2CmF":{"name":"itemSync","abstract":"

    A folder was marked for sync.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemUnsyncyA2CmF":{"name":"itemUnsync","abstract":"

    A folder was un-marked for sync.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemRenamedyA2CmF":{"name":"itemRenamed","abstract":"

    A file or folder was renamed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21itemEnabledForSharingyA2CmF":{"name":"itemEnabledForSharing","abstract":"

    A file or folder was enabled for sharing.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22itemDisabledForSharingyA2CmF":{"name":"itemDisabledForSharing","abstract":"

    A file or folder was disabled for sharing.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemSharedyA2CmF":{"name":"itemShared","abstract":"

    A folder was shared.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22itemMadeCurrentVersionyA2CmF":{"name":"itemMadeCurrentVersion","abstract":"

    A previous version of a file was promoted to the current version.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8tagAddedyA2CmF":{"name":"tagAdded","abstract":"

    A Tag was added to a file or folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16twoFactorEnabledyA2CmF":{"name":"twoFactorEnabled","abstract":"

    2 factor authentication enabled by user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20masterInviteAcceptedyA2CmF":{"name":"masterInviteAccepted","abstract":"

    Free user accepts invitation to become a managed user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20masterInviteRejectedyA2CmF":{"name":"masterInviteRejected","abstract":"

    Free user rejects invitation to become a managed user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13accessGrantedyA2CmF":{"name":"accessGranted","abstract":"

    Granted Box access to account.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13accessRevokedyA2CmF":{"name":"accessRevoked","abstract":"

    Revoke Box access to account.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16addedUserToGroupyA2CmF":{"name":"addedUserToGroup","abstract":"

    Added user to group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20removedUserFromGroupyA2CmF":{"name":"removedUserFromGroup","abstract":"

    Removed user from group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11createdUseryA2CmF":{"name":"createdUser","abstract":"

    Created user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12createdGroupyA2CmF":{"name":"createdGroup","abstract":"

    Created new group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12deletedGroupyA2CmF":{"name":"deletedGroup","abstract":"

    Deleted group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11deletedUseryA2CmF":{"name":"deletedUser","abstract":"

    Deleted user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11editedGroupyA2CmF":{"name":"editedGroup","abstract":"

    Edited group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10editedUseryA2CmF":{"name":"editedUser","abstract":"

    Edited user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10adminLoginyA2CmF":{"name":"adminLogin","abstract":"

    Admin login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21addedDeviceAssocationyA2CmF":{"name":"addedDeviceAssocation","abstract":"

    Added device association

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22changeFolderPermissionyA2CmF":{"name":"changeFolderPermission","abstract":"

    Edit the permissions on a folder

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11failedLoginyA2CmF":{"name":"failedLogin","abstract":"

    Failed login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO5loginyA2CmF":{"name":"login","abstract":"

    Login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24removedDeviceAssociationyA2CmF":{"name":"removedDeviceAssociation","abstract":"

    Removed device association

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22deviceTrustCheckFailedyA2CmF":{"name":"deviceTrustCheckFailed","abstract":"

    Device Trust check failed

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22termsOfServiceAcceptedyA2CmF":{"name":"termsOfServiceAccepted","abstract":"

    Accepted terms

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22termsOfServiceRejectedyA2CmF":{"name":"termsOfServiceRejected","abstract":"

    Rejected terms

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19fileMarkedMaliciousyA2CmF":{"name":"fileMarkedMalicious","abstract":"

    Virus found on a file. Event is only received by enterprises that have opted in to be notified.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6copiedyA2CmF":{"name":"copied","abstract":"

    Copied

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO7deletedyA2CmF":{"name":"deleted","abstract":"

    Deleted

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10downloadedyA2CmF":{"name":"downloaded","abstract":"

    Downloaded

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6editedyA2CmF":{"name":"edited","abstract":"

    Edited

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6lockedyA2CmF":{"name":"locked","abstract":"

    Locked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO5movedyA2CmF":{"name":"moved","abstract":"

    Moved

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9previewedyA2CmF":{"name":"previewed","abstract":"

    Previewed

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO7renamedyA2CmF":{"name":"renamed","abstract":"

    A file or folder name or description is changed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17storageExpirationyA2CmF":{"name":"storageExpiration","abstract":"

    Set file auto-delete

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9undeletedyA2CmF":{"name":"undeleted","abstract":"

    Undeleted

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8unlockedyA2CmF":{"name":"unlocked","abstract":"

    Unlocked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8uploadedyA2CmF":{"name":"uploaded","abstract":"

    Uploaded

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12shareEnabledyA2CmF":{"name":"shareEnabled","abstract":"

    Enabled shared links

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16itemShareUpdatedyA2CmF":{"name":"itemShareUpdated","abstract":"

    Share links settings updated

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22shareExpirationUpdatedyA2CmF":{"name":"shareExpirationUpdated","abstract":"

    Extend shared link expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15shareExpirationyA2CmF":{"name":"shareExpiration","abstract":"

    Set shared link expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8unsharedyA2CmF":{"name":"unshared","abstract":"

    Unshared shared link

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21collaborationAcceptedyA2CmF":{"name":"collaborationAccepted","abstract":"

    Accepted invites

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24collaborationRoleChangedyA2CmF":{"name":"collaborationRoleChanged","abstract":"

    Changed user roles

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO31collaborationExpirationExtendedyA2CmF":{"name":"collaborationExpirationExtended","abstract":"

    Extend collaborator expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20collaborationRemovedyA2CmF":{"name":"collaborationRemoved","abstract":"

    Removed collaborators

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22invitedToCollaborationyA2CmF":{"name":"invitedToCollaboration","abstract":"

    Invited

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23collaborationExpirationyA2CmF":{"name":"collaborationExpiration","abstract":"

    Set collaborator expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24loginActivityDeviceAddedyA2CmF":{"name":"loginActivityDeviceAdded","abstract":"

    A user is logging in from a device we haven’t seen before.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26loginActivityDeviceRemovedyA2CmF":{"name":"loginActivityDeviceRemoved","abstract":"

    We invalidated a user session associated with an app.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO28userOAuth2AccessTokenCreatedyA2CmF":{"name":"userOAuth2AccessTokenCreated","abstract":"

    An OAuth 2.0 access token has been created

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20userAdminRoleChangedyA2CmF":{"name":"userAdminRoleChanged","abstract":"

    When an admin role changes for a user

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO35contentWorkflowUploadPolicyViolatedyA2CmF":{"name":"contentWorkflowUploadPolicyViolated","abstract":"

    A collaborator violated an admin-set upload policy

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataInstanceCreatedyA2CmF":{"name":"metadataInstanceCreated","abstract":"

    Creation of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23matadataInstanceUpdatedyA2CmF":{"name":"matadataInstanceUpdated","abstract":"

    Update of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23matadataInstanceDeletedyA2CmF":{"name":"matadataInstanceDeleted","abstract":"

    Deletion of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21taskAssignmentUpdatedyA2CmF":{"name":"taskAssignmentUpdated","abstract":"

    Update of a task assignment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21taskAssignmentDeletedyA2CmF":{"name":"taskAssignmentDeleted","abstract":"

    A task assignment is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11taskUpdatedyA2CmF":{"name":"taskUpdated","abstract":"

    A task’s comment was edited.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16itemAddedToGroupyA2CmF":{"name":"itemAddedToGroup","abstract":"

    An item is added to a group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20dataRetentionRemovedyA2CmF":{"name":"dataRetentionRemoved","abstract":"

    Retention is removed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20dataRetentionCreatedyA2CmF":{"name":"dataRetentionCreated","abstract":"

    Retention is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO34dataRetentionPolicyAssignmentAddedyA2CmF":{"name":"dataRetentionPolicyAssignmentAdded","abstract":"

    A retention policy assignment is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26legalHoldAssignmentCreatedyA2CmF":{"name":"legalHoldAssignmentCreated","abstract":"

    A legal hold assignment is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26legalHoldAssignmentDeletedyA2CmF":{"name":"legalHoldAssignmentDeleted","abstract":"

    A legal hold assignment is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyCreatedyA2CmF":{"name":"legalHoldPolicyCreated","abstract":"

    A legal hold policy is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyUpdatedyA2CmF":{"name":"legalHoldPolicyUpdated","abstract":"

    A legal hold policy is updated.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyDeletedyA2CmF":{"name":"legalHoldPolicyDeleted","abstract":"

    A legal hold policy is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22sharingPolicyViolationyA2CmF":{"name":"sharingPolicyViolation","abstract":"

    There is a sharing policy violation.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO25applicationPublicKeyAddedyA2CmF":{"name":"applicationPublicKeyAdded","abstract":"

    An application public key is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO27applicationPublicKeyDeletedyA2CmF":{"name":"applicationPublicKeyDeleted","abstract":"

    An application public key is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO18applicationCreatedyA2CmF":{"name":"applicationCreated","abstract":"

    A new application was created in the Box developer console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO18contentPolicyAddedyA2CmF":{"name":"contentPolicyAdded","abstract":"

    A content policy is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15automationAddedyA2CmF":{"name":"automationAdded","abstract":"

    An automation is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17automationDeletedyA2CmF":{"name":"automationDeleted","abstract":"

    An automation is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23userEmailAliasConfirmedyA2CmF":{"name":"userEmailAliasConfirmed","abstract":"

    A user email alias is confirmed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21userEmailAliasRemovedyA2CmF":{"name":"userEmailAliasRemoved","abstract":"

    A user email alias is removed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14watermarkAddedyA2CmF":{"name":"watermarkAdded","abstract":"

    A watermark is added to a file.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16watermarkRemovedyA2CmF":{"name":"watermarkRemoved","abstract":"

    A watermark is removed from a file.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateCreatedyA2CmF":{"name":"metadataTemplateCreated","abstract":"

    Creation of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateUpdatedyA2CmF":{"name":"metadataTemplateUpdated","abstract":"

    Update of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateDeletedyA2CmF":{"name":"metadataTemplateDeleted","abstract":"

    Deletion of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemOpenedyA2CmF":{"name":"itemOpened","abstract":"

    Item was opened.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12itemModifiedyA2CmF":{"name":"itemModified","abstract":"

    Item was modified.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24abnormalDownloadActivityyA2CmF":{"name":"abnormalDownloadActivity","abstract":"

    When a policy set in the Admin console is triggered.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21itemsRemovedFromGroupyA2CmF":{"name":"itemsRemovedFromGroup","abstract":"

    Folders were removed from a group in the Admin console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17itemsAddedToGroupyA2CmF":{"name":"itemsAddedToGroup","abstract":"

    Folders were added to a group in the Admin console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO25watermarkedFileDownloadedyA2CmF":{"name":"watermarkedFileDownloaded","abstract":"

    A watermarked file was downloaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom event type, that is not yet implemented in this SDK version.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of sync state.

    ","parent_name":"EventType"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO9ascendingyA2CmF":{"name":"ascending","abstract":"

    Items sorted in ascending order.

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO10descendingyA2CmF":{"name":"descending","abstract":"

    Items sorted in descending order.

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"OrderDirection"},"Enums/CommentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO7commentyAcA0C0CcACmF":{"name":"comment(_:)","abstract":"

    Comment type

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Debug description of an object

    ","parent_name":"CommentItem"},"Enums/CollaborationItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO6folderyAcA6FolderCcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Debug description of an object

    ","parent_name":"CollaborationItem"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO7inboundyA2CmF":{"name":"inbound","abstract":"

    Inbound collaboration direction

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO8outboundyA2CmF":{"name":"outbound","abstract":"

    Outbound collaboration direction

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO4bothyA2CmF":{"name":"both","abstract":"

    Bi-directional collaboration

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom scope for metadata template.

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"CollaborationDirection"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO6editoryA2CmF":{"name":"editor","abstract":"

    Editor role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO6vieweryA2CmF":{"name":"viewer","abstract":"

    Viewer role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO9previeweryA2CmF":{"name":"previewer","abstract":"

    Previewer rle

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO8uploaderyA2CmF":{"name":"uploader","abstract":"

    Uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO17previewerUploaderyA2CmF":{"name":"previewerUploader","abstract":"

    Preview uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO14viewerUploaderyA2CmF":{"name":"viewerUploader","abstract":"

    Viewer uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO7coOwneryA2CmF":{"name":"coOwner","abstract":"

    Co-owner role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO5owneryA2CmF":{"name":"owner","abstract":"

    Owner role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value of a role that was not yet implemented in this versison of SDK.

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO11descriptionSSvp":{"name":"description","abstract":"

    String representation of role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO8acceptedyA2CmF":{"name":"accepted","abstract":"

    Collaboration invitation accepted

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO7pendingyA2CmF":{"name":"pending","abstract":"

    Collaboration invitation is pending

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Collaboration invitation was rejected

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Collaboration invitation status of custom value that was not yet implemented in this version of SDK.

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO11descriptionSSvp":{"name":"description","abstract":"

    String representation of collaboration status.

    ","parent_name":"CollaborationStatus"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterO5valueyACyxGxcAEmlF":{"name":"value(_:)","abstract":"

    Specifies value that should be set to a parameter

    ","parent_name":"NullableParameter"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterO4nullyACyxGAEmlF":{"name":"null","abstract":"

    Empty value representing null

    ","parent_name":"NullableParameter"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterOAASERzlE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

    Encode the nullable parameter to either null or its encoded value

    ","parent_name":"NullableParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO6offsetyACSicACmF":{"name":"offset(_:)","abstract":"

    Offset

    ","parent_name":"PagingParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO6markeryACSSSgcACmF":{"name":"marker(_:)","abstract":"

    Marker

    ","parent_name":"PagingParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO14streamPositionyACSSSgcACmF":{"name":"streamPosition(_:)","abstract":"

    Stream position

    ","parent_name":"PagingParameter"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO7coadminyA2CmF":{"name":"coadmin","abstract":"

    Coadmin role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO5adminyA2CmF":{"name":"admin","abstract":"

    Admin role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO4useryA2CmF":{"name":"user","abstract":"

    User role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom role that is not yet implemented

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of user’s role.

    ","parent_name":"UserRole"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO6activeyA2CmF":{"name":"active","abstract":"

    User is active

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO8inactiveyA2CmF":{"name":"inactive","abstract":"

    User is inactive

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO18cannotDeleteOrEdityA2CmF":{"name":"cannotDeleteOrEdit","abstract":"

    User cannot delete or edit content

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO24cannotDeleteEditOrUploadyA2CmF":{"name":"cannotDeleteEditOrUpload","abstract":"

    User cannot delete, edit or upload content

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom user status that is not yet implemented

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of user status.

    ","parent_name":"UserStatus"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO7managedyA2CmF":{"name":"managed","abstract":"

    The ToS is allowed to be accepted/rejected by managed users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO8externalyA2CmF":{"name":"external","abstract":"

    The ToS is allowed to be accepted/rejected by external users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of scope of the ToS to the end users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO7enabledyA2CmF":{"name":"enabled","abstract":"

    The ToS is currently enabled and active.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO8disabledyA2CmF":{"name":"disabled","abstract":"

    The ToS is currently disabled and inactive.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO11descriptionSSvp":{"name":"description","abstract":"

    String representation of active/inactive indicator for ToS.

    ","parent_name":"TermsOfServiceStatus"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO4fileyA2CmF":{"name":"file","abstract":"

    Object type file

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO6folderyA2CmF":{"name":"folder","abstract":"

    Object type folder

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO7webLinkyA2CmF":{"name":"webLink","abstract":"

    Object type weblink

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type defined for searching that is not yet implemented.

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of searched item type.

    ","parent_name":"SearchItemType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO4nameyA2CmF":{"name":"name","abstract":"

    Searching in names of items

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11descriptionyA2CmF":{"name":"description","abstract":"

    Searching in description of items

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO12fileContentsyA2CmF":{"name":"fileContents","abstract":"

    Searching in files content

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO8commentsyA2CmF":{"name":"comments","abstract":"

    Searching in comments

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO4tagsyA2CmF":{"name":"tags","abstract":"

    Searching in tags

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom attribute defined for searching that is not yet implemented.

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of search area type

    ","parent_name":"SearchContentType"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO4useryA2CmF":{"name":"user","abstract":"

    Scope limited to current user

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    Scope limited the enterprise.

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom search scope that is not yet implemented. To enable this type of scope for an administrator,","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of scope.

    ","parent_name":"SearchScope"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO4noneyA2CmF":{"name":"none","abstract":"

    Preserve the existing value on the file

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO9overwriteyA2CmF":{"name":"overwrite","abstract":"

    Force-apply the cascade policy’s value over any existing value.

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom conflict resolution method.

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"ConflictResolution"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO2idyA2CmF":{"name":"id","abstract":"

    Order by item identifier

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4nameyA2CmF":{"name":"name","abstract":"

    Order by item name

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4dateyA2CmF":{"name":"date","abstract":"

    Order by item date

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4typeyA2CmF":{"name":"type","abstract":"

    Order by item type

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented by the SDk

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO4openyA2CmF":{"name":"open","abstract":"

    Any user can upload.

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO13collaboratorsyA2CmF":{"name":"collaborators","abstract":"

    Any folder collaborator can upload

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access to a folder’s upload email address that is not yet implemented.

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO11descriptionSSvp":{"name":"description","abstract":"

    Returns a string representation of the folder upload email access

    ","parent_name":"FolderUploadEmailAccess"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO3jpgyA2CmF":{"name":"jpg","abstract":"

    The file extension for Joint Photographic Experts Group (JPEG) thumbnail images

    ","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO3pngyA2CmF":{"name":"png","abstract":"

    The file extension for Portable Network Graphic (PNG) thumbnail images

    ","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom file extension for thumbnail images that is not yet implemented. Check the list of","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of suffix

    ","parent_name":"ThumbnailExtension"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO6activeyA2CmF":{"name":"active","abstract":"

    Item was not deleted or moved to trash.

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO7trashedyA2CmF":{"name":"trashed","abstract":"

    Item has been moved to the trash

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO7deletedyA2CmF":{"name":"deleted","abstract":"

    Item has been permanently deleted

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"ItemStatus"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO9newChangeyA2CmF":{"name":"newChange","abstract":"

    New event appeared.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO9reconnectyA2CmF":{"name":"reconnect","abstract":"

    No new events appeared. Request for a new polling URL.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Value that was not yet implemented in this SDK

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO11descriptionSSvp":{"name":"description","abstract":"

    String representation of the reponse.

    ","parent_name":"EventObserverResponse"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO3allyA2CmF":{"name":"all","abstract":"

    Stream returns all user events

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO7changesyA2CmF":{"name":"changes","abstract":"

    Stream returns events that may cause file tree changes such as file updates or collaborations

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO4syncyA2CmF":{"name":"sync","abstract":"

    Stream returns enterprise-wide events available for administrators

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom stream type that is not yet implemented

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of StreamType

    ","parent_name":"StreamType"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO3nowyA2CmF":{"name":"now","abstract":"

    When used, Box API will return 0 events and the latest streamPosition value to be used for subsequent call.

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO4zeroyA2CmF":{"name":"zero","abstract":"

    When used, Box API will return all available events.

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value of a stream position used when using value not yet implemented in this SDK (of similar usage as none, now or zero)

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of StreamPosition

    ","parent_name":"StreamPosition"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO4useryA2CmF":{"name":"user","abstract":"

    The user that is granted access

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO5groupyA2CmF":{"name":"group","abstract":"

    The group that is granted access

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access that is not yet implemented

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"AccessibleBy"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO12networkAgentyA2CmF":{"name":"networkAgent","abstract":"

    NetworkAgent related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO7modulesyA2CmF":{"name":"modules","abstract":"

    Module related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO6clientyA2CmF":{"name":"client","abstract":"

    BoxCLient related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO3sdkyA2CmF":{"name":"sdk","abstract":"

    The general log for BoxSDK

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO11descriptionSSvp":{"name":"description","abstract":"

    Log category string title

    ","parent_name":"LogCategory"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5debugyA2CmF":{"name":"debug","abstract":"

    Logging only while debugging

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO4infoyA2CmF":{"name":"info","abstract":"

    Logging info message

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5erroryA2CmF":{"name":"error","abstract":"

    Logging error

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5fatalyA2CmF":{"name":"fatal","abstract":"

    Logging fatal error

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO11descriptionSSvp":{"name":"description","abstract":"

    Log level string title

    ","parent_name":"LogLevel"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    The scope of the metadata template is set to the entire “enterprise”.

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO6globalyA2CmF":{"name":"global","abstract":"

    The scope of the metadata template is set to “global”

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom scope for metadata template.

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"MetadataScope"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO8lessThanyA2CmF":{"name":"lessThan","abstract":"

    Inclusive upper bound parameter for field values of floats and dates.

    ","parent_name":"MetadataFilterBound"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO11greaterThanyA2CmF":{"name":"greaterThan","abstract":"

    Inclusive lower bound parameter for field values of floats and dates.

    ","parent_name":"MetadataFilterBound"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO5equalyA2CmF":{"name":"equal","abstract":"

    Set the filter value equal to filter key.

    ","parent_name":"MetadataFilterBound"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO15clientDestroyedyA2CmF":{"name":"clientDestroyed","abstract":"

    Box client was destroyed

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO10invalidURLyACSS_tcACmF":{"name":"invalidURL(urlString:)","abstract":"

    URL is invalid

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO8notFoundyACSScACmF":{"name":"notFound(_:)","abstract":"

    The requested resource was not found

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19instanceDeallocatedyACSScACmF":{"name":"instanceDeallocated(_:)","abstract":"

    Object needed in closure was deallocated

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO27keychainDataConversionErroryA2CmF":{"name":"keychainDataConversionError","abstract":"

    Could not decode or encode keychain data

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO15keychainNoValueyA2CmF":{"name":"keychainNoValue","abstract":"

    Value not found in Keychain

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO22keychainUnhandledErroryACSScACmF":{"name":"keychainUnhandledError(_:)","abstract":"

    Unhandled keychain error

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19rateLimitMaxRetriesyA2CmF":{"name":"rateLimitMaxRetries","abstract":"

    Request has hit the maximum number of retries

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12typeMismatchyACSS_tcACmF":{"name":"typeMismatch(key:)","abstract":"

    Value for key is of an unexpected type

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO13valueMismatchyACSS_SSSaySSGtcACmF":{"name":"valueMismatch(key:value:acceptedValues:)","abstract":"

    Value for key is not one of the accepted values

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO18invalidValueFormatyACSS_tcACmF":{"name":"invalidValueFormat(key:)","abstract":"

    Value for key is of a valid type, but was not able to convert value to expected type

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO10notPresentyACSS_tcACmF":{"name":"notPresent(key:)","abstract":"

    Key was not present

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO28representationCreationFailedyA2CmF":{"name":"representationCreationFailed","abstract":"

    The file representation couldn’t be made

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO17tokenStoreFailureyA2CmF":{"name":"tokenStoreFailure","abstract":"

    Error with TokenStore operation (write, read or clear)

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO14tokenRetrievalyA2CmF":{"name":"tokenRetrieval","abstract":"

    Unsuccessful token retrieval. Token not found

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO33invalidOAuthRedirectConfigurationyA2CmF":{"name":"invalidOAuthRedirectConfiguration","abstract":"

    OAuth web session authorization failed due to invalid redirect configuration

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO17invalidOAuthStateyA2CmF":{"name":"invalidOAuthState","abstract":"

    Couldn’t obtain authorization code from OAuth web session result

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO18unauthorizedAccessyA2CmF":{"name":"unauthorizedAccess","abstract":"

    Unauthorized request to API

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO20refreshTokenNotFoundyA2CmF":{"name":"refreshTokenNotFound","abstract":"

    Unsuccessful refresh token retrieval. Token not found in the retrieved TokenInfo object

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12expiredTokenyA2CmF":{"name":"expiredToken","abstract":"

    Access token has expired

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12jwtAuthErroryA2CmF":{"name":"jwtAuthError","abstract":"

    Authorization with JWT token failed

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19nonIterableResponseyA2CmF":{"name":"nonIterableResponse","abstract":"

    Couldn’t create paging iterable for non-paged response

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO9endOfListyA2CmF":{"name":"endOfList","abstract":"

    The end of the list was reached

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom error message

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:s26ExpressibleByStringLiteralP06stringD0x0cD4TypeQz_tcfc":{"name":"init(stringLiteral:)","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html":{"name":"BoxSDKErrorEnum","abstract":"

    Box SDK Error

    "},"Enums/MetadataFilterBound.html":{"name":"MetadataFilterBound","abstract":"

    Defines the the relation between the filter key and filter value of a metadata template.

    "},"Enums/MetadataScope.html":{"name":"MetadataScope","abstract":"

    Defines the scope of the metadata template.

    "},"Enums/LogLevel.html":{"name":"LogLevel","abstract":"

    Defines character of the log and when it will be displayed

    "},"Enums/LogCategory.html":{"name":"LogCategory","abstract":"

    Defines log category based on what kind of data is being logged

    "},"Enums/AccessibleBy.html":{"name":"AccessibleBy","abstract":"

    Specifies type of value that has granted access to an object.

    "},"Enums/StreamPosition.html":{"name":"StreamPosition","abstract":"

    Stream position used for stream pagination

    "},"Enums/StreamType.html":{"name":"StreamType","abstract":"

    Restricts the types of events returned.

    "},"Enums/EventObserverResponse.html":{"name":"EventObserverResponse","abstract":"

    Defines results for a request checking for new changes in user events

    "},"Enums/ItemStatus.html":{"name":"ItemStatus","abstract":"

    Box item status indicating whether this item is deleted or not.

    "},"Enums/ThumbnailExtension.html":{"name":"ThumbnailExtension","abstract":"

    Defines the file extension of a thumbnail image file.

    "},"Enums/FolderUploadEmailAccess.html":{"name":"FolderUploadEmailAccess","abstract":"

    Defines the level of access to upload a file to a folder via its upload email address

    "},"Enums/FolderItemsOrderBy.html":{"name":"FolderItemsOrderBy","abstract":"

    Defines by which parameter should list of box items be ordered.

    "},"Enums/ConflictResolution.html":{"name":"ConflictResolution","abstract":"

    The desired behavior for conflict-resolution if a template already exists on a given file or folder

    "},"Enums/SearchScope.html":{"name":"SearchScope","abstract":"

    Defines search scope

    "},"Enums/SearchContentType.html":{"name":"SearchContentType","abstract":"

    Defines the attributes for which the search should look for matches

    "},"Enums/SearchItemType.html":{"name":"SearchItemType","abstract":"

    Defines type of objects to include in the search results

    "},"Enums/TermsOfServiceStatus.html":{"name":"TermsOfServiceStatus","abstract":"

    Specifies whether the Terms of Service is currently active or inactive.

    "},"Enums/TermsOfServiceType.html":{"name":"TermsOfServiceType","abstract":"

    Specifies whether the ToS is managed by an enterprise or external to an enterprise.

    "},"Enums/UserStatus.html":{"name":"UserStatus","abstract":"

    Defines user status.

    "},"Enums/UserRole.html":{"name":"UserRole","abstract":"

    Defines user’s role within an enterprise

    "},"Enums/PagingParameter.html":{"name":"PagingParameter","abstract":"

    Stores offset, marker or stream position for the iterator

    "},"Enums/NullableParameter.html":{"name":"NullableParameter","abstract":"

    Type for updating optional parameters - parameters that can either have value of some type, or be nil."},"Enums/CollaborationStatus.html":{"name":"CollaborationStatus","abstract":"

    The status of the collaboration invitation.

    "},"Enums/CollaborationRole.html":{"name":"CollaborationRole","abstract":"

    The level of access granted. To see exactly which role has which permission, please look here

    "},"Enums/CollaborationDirection.html":{"name":"CollaborationDirection","abstract":"

    Direction of the collaboration

    "},"Enums/CollaborationItem.html":{"name":"CollaborationItem","abstract":"

    The file or folder that access is granted to by collaboration.

    "},"Enums/CommentItem.html":{"name":"CommentItem","abstract":"

    Item a comment was placed on

    "},"Enums/OrderDirection.html":{"name":"OrderDirection","abstract":"

    Order direction.

    "},"Enums/EventType.html":{"name":"EventType","abstract":"

    Defines user or enterprise event type

    "},"Enums/FileRepresentationHint.html":{"name":"FileRepresentationHint","abstract":"

    Defines the file type for the generated file representation

    "},"Enums/SyncState.html":{"name":"SyncState","abstract":"

    Defines whether folder will be synced by the Box sync clients or not.

    "},"Enums/FolderItem.html":{"name":"FolderItem","abstract":"

    Files, folders, or web links contained within a folder.

    "},"Enums/GroupInvitabilityLevel.html":{"name":"GroupInvitabilityLevel","abstract":"

    Specifies who can invite the group to collaborate on folders.

    "},"Enums/GroupMemberViewabilityLevel.html":{"name":"GroupMemberViewabilityLevel","abstract":"

    Specifies who can view the members of the group.

    "},"Enums/GroupRole.html":{"name":"GroupRole","abstract":"

    Specifies role of the user within a Group.

    "},"Enums/FileMetadataOperation.html":{"name":"FileMetadataOperation","abstract":"

    Operations on a file metadata

    "},"Enums/FolderMetadataOperation.html":{"name":"FolderMetadataOperation","abstract":"

    Operations on a folder metadata

    "},"Enums/MetadataTemplateOperation.html":{"name":"MetadataTemplateOperation","abstract":"

    Specifies opperations available on metadata template

    "},"Enums/RetentionPolicyType.html":{"name":"RetentionPolicyType","abstract":"

    The type of the retention policy.

    "},"Enums/DispositionAction.html":{"name":"DispositionAction","abstract":"

    The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    "},"Enums/RetentionPolicyStatus.html":{"name":"RetentionPolicyStatus","abstract":"

    The status of the retention policy.

    "},"Enums/RetentionPolicyAssignmentItemType.html":{"name":"RetentionPolicyAssignmentItemType","abstract":"

    Item type with task assignment.

    "},"Enums/TokenScope.html":{"name":"TokenScope","abstract":"

    Specifies permissions that define a token scope

    "},"Enums/SharedLinkAccess.html":{"name":"SharedLinkAccess","abstract":"

    Defines the level of access to the item by its shared link.

    "},"Enums/TaskCompletionRule.html":{"name":"TaskCompletionRule","abstract":"

    Defines the condition that will mark a task as complete

    "},"Enums/TaskAction.html":{"name":"TaskAction","abstract":"

    The action the task assignee will be prompted to perform

    "},"Enums/AssignmentStatus.html":{"name":"AssignmentStatus","abstract":"

    Status of assignment.

    "},"Enums/AssignmentState.html":{"name":"AssignmentState","abstract":"

    State of assignment.

    "},"Enums/TaskItem.html":{"name":"TaskItem","abstract":"

    Item a task is assigned to

    "},"Enums/WebhookItem.html":{"name":"WebhookItem","abstract":"

    Files, folders, or web links associated with a webhook.

    "},"Classes/KeychainTokenStore.html#/s:6BoxSDK18KeychainTokenStoreCACycfc":{"name":"init()","abstract":"

    Initializer method

    ","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP4read10completionyys6ResultOyAA0C4InfoCs5Error_pGc_tF":{"name":"read(completion:)","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP5write9tokenInfo10completionyAA0cG0C_ys6ResultOyyts5Error_pGctF":{"name":"write(tokenInfo:completion:)","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP5clear10completionyys6ResultOyyts5Error_pGc_tF":{"name":"clear(completion:)","parent_name":"KeychainTokenStore"},"Classes/SingleTokenSession.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","parent_name":"SingleTokenSession"},"Classes/SingleTokenSession.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","parent_name":"SingleTokenSession"},"Classes/SingleTokenSession.html#/s:6BoxSDK18SingleTokenSessionC09downscopeD05scope8resource10sharedLink10completionyShyAA0D5ScopeOG_SSSgALys6ResultOyAA0D4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"SingleTokenSession"},"Classes/OAuth2Session.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK20ExpiredTokenHandlingP06handlecD010completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"handleExpiredToken(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK13OAuth2SessionC12refreshToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"refreshToken(completion:)","abstract":"

    Gets refreshed access token if necessary

    ","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK13OAuth2SessionC14downscopeToken5scope8resource10sharedLink10completionyShyAA0F5ScopeOG_SSSgALys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"OAuth2Session"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","abstract":"

    Revokes token

    ","parent_name":"DelegatedAuthSession"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","abstract":"

    Retrieves valid access token

    ","parent_name":"DelegatedAuthSession"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC14downscopeToken5scope8resource10sharedLink10completionyShyAA0G5ScopeOG_SSSgALys6ResultOyAA0G4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"DelegatedAuthSession"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC14totalFileCountSivp":{"name":"totalFileCount","abstract":"

    The total number of files in the zip

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC19downloadedFileCountSivp":{"name":"downloadedFileCount","abstract":"

    The number of files in the zip that were downloaded

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC16skippedFileCountSivp":{"name":"skippedFileCount","abstract":"

    The number of files that were skipped when downloading

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC18skippedFolderCountSivp":{"name":"skippedFolderCount","abstract":"

    The number of folders that were skipped when downloading

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC5stateSSvp":{"name":"state","abstract":"

    State of the download for the zip file

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC13nameConflictsSayAA0cD8ConflictCGSgvp":{"name":"nameConflicts","abstract":"

    Conflicts that occur between items that have the same name. This is always initially nil and updated manually later, via the FilesModule.getZipDownloadStatus() method.

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC2idSSvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC4typeSSvp":{"name":"type","abstract":"

    Box item type - file or folder.

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC12originalNameSSvp":{"name":"originalName","abstract":"

    The original name of the item that has the conflict

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC12downloadNameSSvp":{"name":"downloadName","abstract":"

    The new name of the item when it downloads that resolves the conflict

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadConflict"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK19ZipDownloadConflictC8conflictSayAA0cdE4ItemCGSgvp":{"name":"conflict","abstract":"

    Conflict that occurs between items that have the same name.

    ","parent_name":"ZipDownloadConflict"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK19ZipDownloadConflictC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadConflict"},"Classes/ZipDownload.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC11downloadUrl10Foundation3URLVvp":{"name":"downloadUrl","abstract":"

    The URL to download the Zip file. If entered in a browser, this URL will trigger a download of the Zip file.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC9statusUrl10Foundation3URLVvp":{"name":"statusUrl","abstract":"

    The URL to monitor the status of the download.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    Expiration date of the Zip file download.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC13nameConflictsSayAA0cD8ConflictCGSgvp":{"name":"nameConflicts","abstract":"

    Conflicts that occur between items that have the same name.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownload"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileUploadedyA2EmF":{"name":"fileUploaded","abstract":"

    A file is uploaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13filePreviewedyA2EmF":{"name":"filePreviewed","abstract":"

    A file is previewed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14fileDownloadedyA2EmF":{"name":"fileDownloaded","abstract":"

    A file is downloaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileTrashedyA2EmF":{"name":"fileTrashed","abstract":"

    A file is moved to the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileDeletedyA2EmF":{"name":"fileDeleted","abstract":"

    A file is permanently deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileRestoredyA2EmF":{"name":"fileRestored","abstract":"

    A file is restored from the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO10fileCopiedyA2EmF":{"name":"fileCopied","abstract":"

    A file is copied

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO9fileMovedyA2EmF":{"name":"fileMoved","abstract":"

    A file is moved from one folder to another

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO10fileLockedyA2EmF":{"name":"fileLocked","abstract":"

    A file is locked

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileUnlockedyA2EmF":{"name":"fileUnlocked","abstract":"

    A file is unlocked

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileRenamedyA2EmF":{"name":"fileRenamed","abstract":"

    A file was renamed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentCreatedyA2EmF":{"name":"commentCreated","abstract":"

    A comment object is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentUpdatedyA2EmF":{"name":"commentUpdated","abstract":"

    A comment object is edited

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentDeletedyA2EmF":{"name":"commentDeleted","abstract":"

    A comment object is removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21taskAssignmentCreatedyA2EmF":{"name":"taskAssignmentCreated","abstract":"

    A task is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21taskAssignmentUpdatedyA2EmF":{"name":"taskAssignmentUpdated","abstract":"

    A task assignment is changed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceCreatedyA2EmF":{"name":"metadataInstanceCreated","abstract":"

    A new metadata template instance is associated with a file or folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceUpdatedyA2EmF":{"name":"metadataInstanceUpdated","abstract":"

    An attribute (value) is updated/deleted for an existing metadata template instance associated with a file or folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceDeletedyA2EmF":{"name":"metadataInstanceDeleted","abstract":"

    An existing metadata template instance associated with a file or folder is deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderCreatedyA2EmF":{"name":"folderCreated","abstract":"

    A folder is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderRenamedyA2EmF":{"name":"folderRenamed","abstract":"

    A folder was renamed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO16folderDownloadedyA2EmF":{"name":"folderDownloaded","abstract":"

    A folder is downloaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14folderRestoredyA2EmF":{"name":"folderRestored","abstract":"

    A folder is restored from the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderDeletedyA2EmF":{"name":"folderDeleted","abstract":"

    A folder is permanently removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12folderCopiedyA2EmF":{"name":"folderCopied","abstract":"

    A copy of a folder is made

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11folderMovedyA2EmF":{"name":"folderMoved","abstract":"

    A folder is moved to a different folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderTrashedyA2EmF":{"name":"folderTrashed","abstract":"

    A folder is moved to the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14webhookDeletedyA2EmF":{"name":"webhookDeleted","abstract":"

    When a webhook is deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationCreatedyA2EmF":{"name":"collaborationCreated","abstract":"

    A collaboration is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21collaborationAcceptedyA2EmF":{"name":"collaborationAccepted","abstract":"

    A collaboration has been accepted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21collaborationRejectedyA2EmF":{"name":"collaborationRejected","abstract":"

    A collaboration has been rejected

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationRemovedyA2EmF":{"name":"collaborationRemoved","abstract":"

    A collaboration has been removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationUpdatedyA2EmF":{"name":"collaborationUpdated","abstract":"

    A collaboration has been updated

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkDeletedyA2EmF":{"name":"sharedLinkDeleted","abstract":"

    A shared link was deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkCreatedyA2EmF":{"name":"sharedLinkCreated","abstract":"

    A shared link was created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkUpdatedyA2EmF":{"name":"sharedLinkUpdated","abstract":"

    A shared link was updated

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html":{"name":"EventTriggers","abstract":"

    Event triggers for webhooks

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC6targetAA0C4ItemOSgvp":{"name":"target","abstract":"

    Target information

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    User that created the webhook

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    Timestamp of when webhook was created

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC7address10Foundation3URLVSgvp":{"name":"address","abstract":"

    URL to which notifications are sent

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC8triggersSayAC13EventTriggersOGSgvp":{"name":"triggers","abstract":"

    Events that activate the webhook

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Webhook"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Can rename web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Can delete web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV10canCommentSbSgvp":{"name":"canComment","abstract":"

    Can comment on web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Can share web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Can set share access for web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html":{"name":"Permissions","abstract":"

    Web link permissions

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this web link. Used with If-Match headers.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4nameSSSgvp":{"name":"name","abstract":"

    The name of this web link.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    The URL this web link points to.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When this web link was created

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this web link was last updated

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    The parent object the web link belongs to.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC11descriptionSSSgvp":{"name":"description","abstract":"

    The description accompanying the web link. This is visible within the Box web application.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10itemStatusAA04ItemF0OSgvp":{"name":"itemStatus","abstract":"

    Status of the web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When this web link was last moved to the trash

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When this web link will be permanently deleted.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC06sharedD0AA06SharedD0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this web link. Is nil if no shared link has been created.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC14pathCollectionAA04PathF0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this link, starting at the root

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last modified this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Web link permissions

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"WebLink"},"Classes/Watermark.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC11resourceKeySSvpZ":{"name":"resourceKey","abstract":"

    Key for watermark data JSON object

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC10imprintKeySSvpZ":{"name":"imprintKey","abstract":"

    Key for imprint data in JSON object

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC14defaultImprintSSvpZ":{"name":"defaultImprint","abstract":"

    Default imprint text

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time this watermark was created.

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time this watermark was last modified.

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Watermark"},"Classes/User/TrackingCode.html#/s:6BoxSDK4UserC12TrackingCodeV4nameSSvp":{"name":"name","abstract":"

    Code name

    ","parent_name":"TrackingCode"},"Classes/User/TrackingCode.html#/s:6BoxSDK4UserC12TrackingCodeV5valueSSvp":{"name":"value","abstract":"

    Code value

    ","parent_name":"TrackingCode"},"Classes/User/TrackingCode.html":{"name":"TrackingCode","abstract":"

    A custom values set by the user’s admin to track user’s activity.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4nameSSSgvp":{"name":"name","abstract":"

    The name of the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC5loginSSSgvp":{"name":"login","abstract":"

    The email address the user uses to log in.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the user object was created.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the user object was last modified.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8languageSSSgvp":{"name":"language","abstract":"

    The user’s preferred language.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8timezoneSSSgvp":{"name":"timezone","abstract":"

    The user’s timezone.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC11spaceAmountSiSgvp":{"name":"spaceAmount","abstract":"

    The user’s total available space amount in bytes.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9spaceUsedSiSgvp":{"name":"spaceUsed","abstract":"

    The amount of space in use by the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13maxUploadSizeSiSgvp":{"name":"maxUploadSize","abstract":"

    The maximum individual file size in bytes the user can have.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC6statusAA0C6StatusOSgvp":{"name":"status","abstract":"

    User’s status.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8jobTitleSSSgvp":{"name":"jobTitle","abstract":"

    The user’s job title.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC5phoneSSSgvp":{"name":"phone","abstract":"

    The user’s phone number.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC7addressSSSgvp":{"name":"address","abstract":"

    The user’s address.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9avatarUrl10Foundation3URLVSgvp":{"name":"avatarUrl","abstract":"

    URL of the user’s avatar image.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4roleSSSgvp":{"name":"role","abstract":"

    The user’s enterprise role.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13trackingCodesSayAC12TrackingCodeVGSgvp":{"name":"trackingCodes","abstract":"

    An array of key/value pairs set by the user’s admin.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC18canSeeManagedUsersSbSgvp":{"name":"canSeeManagedUsers","abstract":"

    Whether the user can see other enterprise users in their contact list.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13isSyncEnabledSbSgvp":{"name":"isSyncEnabled","abstract":"

    Whether the user can use Box Sync.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC26isExternalCollabRestrictedSbSgvp":{"name":"isExternalCollabRestricted","abstract":"

    Whether the user is allowed to collaborate with users outside her enterprise.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC24isExemptFromDeviceLimitsSbSgvp":{"name":"isExemptFromDeviceLimits","abstract":"

    Whether to exempt the user from Enterprise device limits.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC29isExemptFromLoginVerificationSbSgvp":{"name":"isExemptFromLoginVerification","abstract":"

    Whether the user must use two-factor authentication.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the user’s enterprise.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC6myTagsSaySSGSgvp":{"name":"myTags","abstract":"

    Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8hostnameSSSgvp":{"name":"hostname","abstract":"

    The root (protocol, subdomain, domain) of any links that need to be generated for the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC20isPlatformAccessOnlySbSgvp":{"name":"isPlatformAccessOnly","abstract":"

    Whether the user is an App User.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC011externalAppC2IdSSSgvp":{"name":"externalAppUserId","abstract":"

    External app user ID.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"User"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV9listParts10Foundation3URLVSgvp":{"name":"listParts","abstract":"

    List parts endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV6commit10Foundation3URLVSgvp":{"name":"commit","abstract":"

    Commit part endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV8logEvent10Foundation3URLVSgvp":{"name":"logEvent","abstract":"

    Log event endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV10uploadPart10Foundation3URLVSgvp":{"name":"uploadPart","abstract":"

    Upload part endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV6status10Foundation3URLVSgvp":{"name":"status","abstract":"

    Upload status endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV5abort10Foundation3URLVSgvp":{"name":"abort","abstract":"

    Abort upload endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html":{"name":"UploadSessionEndpoints","abstract":"

    Internal struct containing URLs for upload session manipulation

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC10totalPartsSivp":{"name":"totalParts","abstract":"

    Count of uploaded parts

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC8partSizeSivp":{"name":"partSize","abstract":"

    Size of uploaded part. Each part’s size must be exactly equal in size to the part size specified","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC17numPartsProcessedSivp":{"name":"numPartsProcessed","abstract":"

    Number of parts processed

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC16sessionExpiresAt10Foundation4DateVvp":{"name":"sessionExpiresAt","abstract":"

    The validity end of this session

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC16sessionEndpointsAC0cdF0Vvp":{"name":"sessionEndpoints","abstract":"

    Set of URL for upload session management

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"UploadSession"},"Classes/UploadPart.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"UploadPart"},"Classes/UploadPart.html#/s:6BoxSDK10UploadPartC4partAA0cD11DescriptionVvp":{"name":"part","abstract":"

    Part description object

    ","parent_name":"UploadPart"},"Classes/UploadPart.html#/s:6BoxSDK10UploadPartC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"UploadPart"},"Classes/TrackingCode.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC4nameSSvp":{"name":"name","abstract":"

    Tracking code key.

    ","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC5valueSSvp":{"name":"value","abstract":"

    Tracking code value.

    ","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TrackingCode"},"Classes/TokenInfo.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC06accessC007refreshC09expiresIn9tokenTypeACSS_SSSgSdSStcfc":{"name":"init(accessToken:refreshToken:expiresIn:tokenType:)","abstract":"

    Initializer

    ","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC06accessC09expiresInACSS_Sdtcfc":{"name":"init(accessToken:expiresIn:)","abstract":"

    Initializer.

    ","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compares tokens

    ","parent_name":"TokenInfo"},"Classes/Token.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC06accessC0SSSgvp":{"name":"accessToken","abstract":"

    Access token.

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC9expiresInSiSgvp":{"name":"expiresIn","abstract":"

    Expiration time interval since

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC9tokenTypeSSSgvp":{"name":"tokenType","abstract":"

    Type of token

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC12restrictedToSayAA5ScopeCGSgvp":{"name":"restrictedTo","abstract":"

    Token permissions

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Token"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC2idSSvp":{"name":"id","abstract":"

    The ID of the user status object for the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC3tosAA0cdE0CSgvp":{"name":"tos","abstract":"

    The Terms of Service this status is associated with.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4userAA0F0CSgvp":{"name":"user","abstract":"

    The user that is associated with the current status of the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC10isAcceptedSbSgvp":{"name":"isAccepted","abstract":"

    Indicator as to whether or not the user has accepted the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date the user status for the ToS was created.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date the user status for the ToS was modified.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC6statusAA0cdE6StatusOSgvp":{"name":"status","abstract":"

    An enum indicating whether the ToS is currently active or inactive.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    A mini Box enterprise object that the ToS is associated with.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC7tosTypeAA0cdeG0OSgvp":{"name":"tosType","abstract":"

    The scope of the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4textSSSgvp":{"name":"text","abstract":"

    The agreement of the ToS specified for the user in the custom application.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date created at for the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date modified at for the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfService"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    File an assignment is on.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    Date of assignment.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC6statusAA0D6StatusOSgvp":{"name":"status","abstract":"

    Assignment status.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC7messageSSSgvp":{"name":"message","abstract":"

    A message from the assignee about this task.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedToAA4UserCSgvp":{"name":"assignedTo","abstract":"

    The user task is assigned to.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    The user task is assigned by.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC15resolutionStateAA0dF0OSgvp":{"name":"resolutionState","abstract":"

    State of assignment. Can be completed, incomplete, approved, or rejected.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TaskAssignment"},"Classes/Task.html#/s:6BoxSDK4TaskC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The file associated with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC5dueAt10Foundation4DateVSgvp":{"name":"dueAt","abstract":"

    When the task is due.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC6actionAA0C6ActionOSgvp":{"name":"action","abstract":"

    The action the task assignee will be prompted to do. Depending on task type, this can be “review” or “complete”.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC7messageSSSgvp":{"name":"message","abstract":"

    A message that will be included with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC24taskAssignmentCollectionAA14EntryContainerCyAA0cE0CGSgvp":{"name":"taskAssignmentCollection","abstract":"

    A collection of mini task_assignment objects associated with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC11isCompletedSbSgvp":{"name":"isCompleted","abstract":"

    Whether the task has been completed.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the task object was created.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC14completionRuleAA0c10CompletionE0OSgvp":{"name":"completionRule","abstract":"

    The rule that determines whether a task is completed

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Task"},"Classes/StoragePolicyAssignment/AssignedTo.html#/s:6BoxSDK23StoragePolicyAssignmentC10AssignedToV4typeSSvp":{"name":"type","abstract":"

    Type of item storage policy is assigned to

    ","parent_name":"AssignedTo"},"Classes/StoragePolicyAssignment/AssignedTo.html#/s:6BoxSDK23StoragePolicyAssignmentC10AssignedToV2idSSvp":{"name":"id","abstract":"

    Id of item storage policy is assigned to

    ","parent_name":"AssignedTo"},"Classes/StoragePolicyAssignment/AssignedTo.html":{"name":"AssignedTo","abstract":"

    Enterprise storage policy is assigned to

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Id of the storage policy assignment

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC07storageD0AA0cD0CSgvp":{"name":"storagePolicy","abstract":"

    Storage policy

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC10assignedToAC08AssignedG0VSgvp":{"name":"assignedTo","abstract":"

    Enterprise the storage policy is assigned to

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC2idSSvp":{"name":"id","abstract":"

    Id of the storage policy

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4nameSSSgvp":{"name":"name","abstract":"

    Name for a storage zone

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StoragePolicy"},"Classes/SharedLink/Permissions.html#/s:6BoxSDK10SharedLinkC11PermissionsV10canPreviewSbSgvp":{"name":"canPreview","abstract":"

    Whether the shared link allows previewing. For shared links on folders, this also applies to any items in the folder.

    ","parent_name":"Permissions"},"Classes/SharedLink/Permissions.html#/s:6BoxSDK10SharedLinkC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Whether the shared link allows downloads. For shared links on folders, this also applies to any items in the folder.

    ","parent_name":"Permissions"},"Classes/SharedLink/Permissions.html":{"name":"Permissions","abstract":"

    Permission for a user accessing item by shared link

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    The URL to access the item on Box. If entered in a browser, this URL will display the item in Box’s preview UI.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC11downloadURL10Foundation0F0VSgvp":{"name":"downloadURL","abstract":"

    The “direct Link” URL to download the item. If entered in a browser, this URL will trigger a download of the item.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC9vanityURL10Foundation0F0VSgvp":{"name":"vanityURL","abstract":"

    The “Custom URL” that can also be used to preview the item on Box.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC15effectiveAccessSSSgvp":{"name":"effectiveAccess","abstract":"

    The effective access level for the shared link. This can be lower than the value in the access field","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC19effectivePermissionSSSgvp":{"name":"effectivePermission","abstract":"

    Actual permissions that are allowed by the shared link, taking into account enterprise and user settings.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC17isPasswordEnabledSbSgvp":{"name":"isPasswordEnabled","abstract":"

    Whether the shared link has a password set.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC10unsharedAt10Foundation4DateVSgvp":{"name":"unsharedAt","abstract":"

    The date-time that this link will become disabled. This field can only be set by users with paid accounts.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC13downloadCountSiSgvp":{"name":"downloadCount","abstract":"

    The number of times the item has been downloaded.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC12previewCountSiSgvp":{"name":"previewCount","abstract":"

    The number of times the item has been previewed.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC6accessAA0cD6AccessOSgvp":{"name":"access","abstract":"

    The access level specified when the shared link was created.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Permissions for download and preview of the item.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SharedLink"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"SharedItemType"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"SharedItemType"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO7webLinkyAeA03WebG0CcAEmF":{"name":"webLink(_:)","abstract":"

    Web link type

    ","parent_name":"SharedItemType"},"Classes/SharedItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SharedItem"},"Classes/SharedItem/SharedItemType.html":{"name":"SharedItemType","abstract":"

    Type of shared item

    ","parent_name":"SharedItem"},"Classes/SharedItem.html#/s:6BoxSDK10SharedItemC9itemValueAC0cD4TypeOvp":{"name":"itemValue","abstract":"

    Shared item value

    ","parent_name":"SharedItem"},"Classes/SharedItem.html#/s:6BoxSDK10SharedItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SharedItem"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC23accessibleViaSharedLink10Foundation3URLVSgvp":{"name":"accessibleViaSharedLink","abstract":"

    The optional shared link through which the user has access to this item.","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4itemAA10FolderItemOvp":{"name":"item","abstract":"

    The file, folder or web link that matched the search query.

    ","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SearchResult"},"Classes/Scope.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC5scopeSSSgvp":{"name":"scope","abstract":"

    Scope permission

    ","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC6objectAA4FileCSgvp":{"name":"object","abstract":"

    The file scope is applied to

    ","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Scope"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC4nameSSSgvp":{"name":"name","abstract":"

    The name of the retention policy.

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC2idSSSgvp":{"name":"id","abstract":"

    ID of the content that is under retention.","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC4typeAA0cdeF4TypeOSgvp":{"name":"type","abstract":"

    Type of the content that is under retention.

    ","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC09retentionD0AA0cD0CSgvp":{"name":"retentionPolicy","abstract":"

    A mini retention policy object representing the retention policy that has been assigned to this content.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedToAA0cdE4ItemCSgvp":{"name":"assignedTo","abstract":"

    Content that is under retention. The type can either be folder or enterprise.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    A mini user object representing the user that created the retention policy assignment object.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    When the retention policy assignment object was created.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC12filterFieldsSayAA19MetadataFieldFilterVGSgvp":{"name":"filterFields","abstract":"

    The array of metadata field filters, if present

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC4nameSSSgvp":{"name":"name","abstract":"

    The name of the retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC10policyTypeAA0cdF0OSgvp":{"name":"policyType","abstract":"

    The type of the retention policy based on whether the amount of time to retain content is known or unknown.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC15retentionLengthSiSgvp":{"name":"retentionLength","abstract":"

    The length of the retention policy. This length specifies the duration in days that the retention policy will be active","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC17dispositionActionAA011DispositionF0OSgvp":{"name":"dispositionAction","abstract":"

    The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC6statusAA0cD6StatusOSgvp":{"name":"status","abstract":"

    The status of the retention policy. Can be either active or retired. Once a policy has been retired, it cannot become active again.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    A mini user object representing the user that created the retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the retention policy object was created.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the retention policy object was last modified.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC014canOwnerExtendC0SbSgvp":{"name":"canOwnerExtendRetention","abstract":"

    Wheter owner can extend time of retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC17areOwnersNotifiedSbSgvp":{"name":"areOwnersNotified","abstract":"

    Whether owners are notified about retention policy changes.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC28customNotificationRecipientsSayAA4UserCGSgvp":{"name":"customNotificationRecipients","abstract":"

    Other users notified about retention policy changes.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicy"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11itemPreviewyA2EmF":{"name":"itemPreview","abstract":"

    Item was previewd

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO10itemUploadyA2EmF":{"name":"itemUpload","abstract":"

    Item was uploaded

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11itemCommentyA2EmF":{"name":"itemComment","abstract":"

    Item was commented on

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO8itemOpenyA2EmF":{"name":"itemOpen","abstract":"

    Item was opened

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO10itemModifyyA2EmF":{"name":"itemModify","abstract":"

    Item was modified

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html":{"name":"InteractionType","abstract":"

    Interaction type with item

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC15interactionTypeAC011InteractionF0Ovp":{"name":"interactionType","abstract":"

    Type of interation

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC12interactedAt10Foundation4DateVvp":{"name":"interactedAt","abstract":"

    Timestamp of the interactions

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4itemAA4FileCvp":{"name":"item","abstract":"

    The item

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC21interactionSharedLinkSSSgvp":{"name":"interactionSharedLink","abstract":"

    Shared link of interaction

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"RecentItem"},"Classes/PollingURLInfo.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC3url10Foundation3URLVvp":{"name":"url","abstract":"

    URL value for checking for new events.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC16timeoutInSecondsSivp":{"name":"timeoutInSeconds","abstract":"

    Timeout in seconds after which request for new changes should be repeated.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC10maxRetriesSSvp":{"name":"maxRetries","abstract":"

    Maximum number of retries in case of failed request for new changes.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PollingURLInfo"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    Box item type

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7versionSivp":{"name":"version","abstract":"

    Version

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7messageAA21EventObserverResponseOvp":{"name":"message","abstract":"

    Message specifying type of the response.

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PollingResult"},"Classes/PathCollection.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of entries in a path

    ","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC7entriesSayAA6FolderCGSgvp":{"name":"entries","abstract":"

    Entries (folders) in a path to an item

    ","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PathCollection"},"Classes/MetadataTemplate.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC2idSSSgvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC11templateKeySSSgvp":{"name":"templateKey","abstract":"

    A unique identifier for the template. The identifier must be unique across the scope of the enterprise to which the metadata template is being applied.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC5scopeSSSgvp":{"name":"scope","abstract":"

    The scope of the object. Global and enterprise scopes are supported.","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC11displayNameSSSgvp":{"name":"displayName","abstract":"

    The display name of the template.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC6hiddenSbSgvp":{"name":"hidden","abstract":"

    Whether this template is hidden in the UI.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC22copyInstanceOnItemCopySbSgvp":{"name":"copyInstanceOnItemCopy","abstract":"

    Whether or not to copy any metadata attached to a file or folder when it is copied. By default, metadata is not copied along with a file or folder when it is copied.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC6fieldsSayAA0C5FieldVGSgvp":{"name":"fields","abstract":"

    The ordered set of key:value pairs for the template.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataObject.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC2idSSSgvp":{"name":"id","abstract":"

    Identifier.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC8templateSSSgvp":{"name":"template","abstract":"

    The key of the template.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC5scopeSSSgvp":{"name":"scope","abstract":"

    The scope of the object. global and enterprise scopes are supported. The global scope contains the properties template,","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC6parentSSSgvp":{"name":"parent","abstract":"

    The ID of the object the metadata object belongs to. Both file and folder objects are supported.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC7versionSiSgvp":{"name":"version","abstract":"

    The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4typeSSSgvp":{"name":"type","abstract":"

    A unique identifier for the “type” of this instance.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC11typeVersionSiSgvp":{"name":"typeVersion","abstract":"

    The last-known version of the template of the object.","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4keysSDySSypGvp":{"name":"keys","abstract":"

    Custom value(s) defined by the template. These values also have a corresponding display name","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataObject"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC4typeSSvp":{"name":"type","abstract":"

    Object type.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC2idSSvp":{"name":"id","abstract":"

    Identifier.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC15ownerEnterpriseAA0G0CSgvp":{"name":"ownerEnterprise","abstract":"

    The enterprise that owns the policy.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    Represent the parent of the policy and the metadata instance to cascade down.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC5scopeAA0C5ScopeOSgvp":{"name":"scope","abstract":"

    The scope of the target instance that will be cascaded down. The scope & templateKey together identify","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC11templateKeySSSgvp":{"name":"templateKey","abstract":"

    The template key of the target metadata template to cascade down. The scope & templateKey together identify","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataCascadePolicy"},"Classes/Lock.html#/s:6BoxSDK4LockC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    Who created the lock.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When was lock created.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When lock expires.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC19isDownloadPreventedSbSgvp":{"name":"isDownloadPrevented","abstract":"

    Whether or not the file can be downloaded while locked.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Lock"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    FIle type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO11fileVersionyAeA04FileJ0CcAEmF":{"name":"fileVersion(_:)","abstract":"

    File version type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html":{"name":"AssignmentItemType","abstract":"

    Type of item legal hold policy was assigned to

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC9itemValueAC0fG4TypeOvp":{"name":"itemValue","abstract":"

    Item that the legal hold policy is assigned to

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC05legaldE0AA0cdE0CSgvp":{"name":"legalHoldPolicy","abstract":"

    The policy that the legal hold policy assignment is part of.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedToAA0cdeF4ItemCSgvp":{"name":"assignedTo","abstract":"

    The entity that the legal hold policy assignment is assigned to.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    The user who created the legal hold policy assignment.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    When the legal hold policy assignment object was created.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    When the assignment release request was sent.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO6activeyA2EmF":{"name":"active","abstract":"

    The policy is not in a transition state

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO8applyingyA2EmF":{"name":"applying","abstract":"

    That the policy is in the process of being applied

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO9releasingyA2EmF":{"name":"releasing","abstract":"

    That the process is in the process of being released

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO8releasedyA2EmF":{"name":"released","abstract":"

    The policy is no longer active

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"Status"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV4userSivp":{"name":"user","abstract":"

    Number of assigned users

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV6folderSivp":{"name":"folder","abstract":"

    Number of assigned folders

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV4fileSivp":{"name":"file","abstract":"

    Number of assigned files

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV11fileVersionSivp":{"name":"fileVersion","abstract":"

    Number of assigned file verions

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html":{"name":"AssignmentCounts","abstract":"

    Counts of the assignments to different entities of this policy

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy/Status.html":{"name":"Status","abstract":"

    Status of legal hold policy

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC10policyNameSSSgvp":{"name":"policyName","abstract":"

    Name of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC11descriptionSSSgvp":{"name":"description","abstract":"

    Description of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC6statusAC6StatusOSgvp":{"name":"status","abstract":"

    Status of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC16assignmentCountsAC010AssignmentG0VSgvp":{"name":"assignmentCounts","abstract":"

    Counts of assignments within this policy by apply-to type.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the legal hold policy object.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the legal hold policy object was created.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the legal hold policy object was modified.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    When the policy release request was sent.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC15filterStartedAt10Foundation4DateVSgvp":{"name":"filterStartedAt","abstract":"

    User-specified, optional date filter applies to Custodian assignments only.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC13filterEndedAt10Foundation4DateVSgvp":{"name":"filterEndedAt","abstract":"

    User-specified, optional date filter applies to Custodian assignments only.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC12releaseNotesSSSgvp":{"name":"releaseNotes","abstract":"

    Notes about why the policy was released.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicy"},"Classes/Invite.html#/s:6BoxSDK6InviteC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9invitedToAA10EnterpriseCSgvp":{"name":"invitedTo","abstract":"

    Enterprise object user is invited to.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC12actionableByAA4UserCSgvp":{"name":"actionableBy","abstract":"

    The user who was invited to the enterprise

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9invitedByAA4UserCSgvp":{"name":"invitedBy","abstract":"

    User who created the invitation.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC6statusSSSgvp":{"name":"status","abstract":"

    Invitation status

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When invitation was created.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When invitation was updated.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Invite"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV13canRunReportsSbvp":{"name":"canRunReports","abstract":"

    Group can run reports

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV15canInstantLoginSbvp":{"name":"canInstantLogin","abstract":"

    Group can login instantly

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV17canCreateAccountsSbvp":{"name":"canCreateAccounts","abstract":"

    Group can create accounts

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV15canEditAccountsSbvp":{"name":"canEditAccounts","abstract":"

    Group can edit accounts

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html":{"name":"ConfigurablePermissions","abstract":"

    Permissions of group membership

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC2idSSvp":{"name":"id","abstract":"

    The ID of the association between a user and a group.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4userAA4UserCSgvp":{"name":"user","abstract":"

    A user object associated with the group.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC5groupAA0C0CSgvp":{"name":"group","abstract":"

    The group the user is associated with.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4roleAA0C4RoleOSgvp":{"name":"role","abstract":"

    The role of the user within the group. The default is member with an option for admin.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC23configurablePermissionsAC012ConfigurableF0VSgvp":{"name":"configurablePermissions","abstract":"

    Permissions of an individual group member.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date time this membership was created at.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date time this membership was modified at.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"GroupMembership"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO07managedC0yA2EmF":{"name":"managedGroup","abstract":"

    Group is managed by the Enterprise admin

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO08allUsersC0yA2EmF":{"name":"allUsersGroup","abstract":"

    A Box-defined group that includes all users in an Enterprise

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this SDK.

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"GroupType"},"Classes/Group/GroupType.html":{"name":"GroupType","abstract":"

    The type of the group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC2idSSvp":{"name":"id","abstract":"

    The ID of the group object.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4nameSSSgvp":{"name":"name","abstract":"

    The name of the group

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC9groupTypeAC0cE0OSgvp":{"name":"groupType","abstract":"

    The type of the group

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the group object was created.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the group object was last modified.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC10provenanceSSSgvp":{"name":"provenance","abstract":"

    Keeps track of which external source this group is coming.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC11descriptionSSSgvp":{"name":"description","abstract":"

    Human readable description of the group. This can be up to 255 characters long

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC22externalSyncIdentifierSSSgvp":{"name":"externalSyncIdentifier","abstract":"

    An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC17invitabilityLevelAA0c12InvitabilityE0OSgvp":{"name":"invitabilityLevel","abstract":"

    Specifies who can invite the group to collaborate on folders.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC22memberViewabilityLevelAA0c6MembereF0OSgvp":{"name":"memberViewabilityLevel","abstract":"

    Specifies who can view the members of the group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Group"},"Classes/FolderUploadEmail.html#/s:6BoxSDK17FolderUploadEmailC6accessSSSgvp":{"name":"access","abstract":"

    Access level

    ","parent_name":"FolderUploadEmail"},"Classes/FolderUploadEmail.html#/s:6BoxSDK17FolderUploadEmailC5emailSSSgvp":{"name":"email","abstract":"

    Email addresss

    ","parent_name":"FolderUploadEmail"},"Classes/FolderLock/LockedOperations.html#/s:6BoxSDK10FolderLockC16LockedOperationsV6deleteSbSgvp":{"name":"delete","abstract":"

    Whether deleting the folder is restricted.

    ","parent_name":"LockedOperations"},"Classes/FolderLock/LockedOperations.html#/s:6BoxSDK10FolderLockC16LockedOperationsV4moveSbSgvp":{"name":"move","abstract":"

    Whether moving the folder is restricted.

    ","parent_name":"LockedOperations"},"Classes/FolderLock/LockedOperations.html":{"name":"LockedOperations","abstract":"

    Locked operations on the folder

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user or group that created the lock.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the folder lock object was created.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC6folderAA0C0CSgvp":{"name":"folder","abstract":"

    The (mini) folder object that the lock applies to.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC8lockTypeSSSgvp":{"name":"lockType","abstract":"

    The lock type, value is always “freeze”.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC16lockedOperationsAC06LockedF0VSgvp":{"name":"lockedOperations","abstract":"

    The operations that have been locked.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FolderLock"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Download permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canUploadSbSgvp":{"name":"canUpload","abstract":"

    Upload permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Rename permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Delete permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Share permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV21canInviteCollaboratorSbSgvp":{"name":"canInviteCollaborator","abstract":"

    Permission to add collaborators

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Permission to set shared link access level for the folder

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html":{"name":"Permissions","abstract":"

    An object containing the permissions that the current user has on this file.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this folder. Used with If-Match headers.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4nameSSSgvp":{"name":"name","abstract":"

    The name of the folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time the folder was created.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this folder was last updated on the Box servers.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the folder. The limit is 256 characters.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC37isCollaborationRestrictedToEnterpriseSbSgvp":{"name":"isCollaborationRestrictedToEnterprise","abstract":"

    Whether future collaborations should be restricted to within the enterprise only

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4sizeSiSgvp":{"name":"size","abstract":"

    The folder size in bytes.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC14pathCollectionAA04PathE0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this folder, starting at the root.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last modified this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10sharedLinkAA06SharedE0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this file. Is nil if no shared link has been created.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17folderUploadEmailAA0ceF0CSgvp":{"name":"folderUploadEmail","abstract":"

    The upload email address for this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC6parentACSgvp":{"name":"parent","abstract":"

    The folder that contains this folder. May be nil for folders such as root, trash and child folders whose parent is inaccessible.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10itemStatusAA04ItemE0OSgvp":{"name":"itemStatus","abstract":"

    Whether this item is deleted or not.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC16contentCreatedAt10Foundation4DateVSgvp":{"name":"contentCreatedAt","abstract":"

    The time the folder or its contents were originally created (according to the uploader). May be nil for some folders such as root or trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17contentModifiedAt10Foundation4DateVSgvp":{"name":"contentModifiedAt","abstract":"

    The time the folder or its contents were last modified (according to the uploader). May be nil for some folders such as root or trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC18canNonOwnersInviteSbSgvp":{"name":"canNonOwnersInvite","abstract":"

    Whether non-owners can invite collaborators to this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    The time the folder or its contents were put in the trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    The time the folder or its contents will be purged from the trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9syncStateAA04SyncE0OSgvp":{"name":"syncState","abstract":"

    Whether this folder will be synced by the Box sync clients or not.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17hasCollaborationsSbSgvp":{"name":"hasCollaborations","abstract":"

    Whether this folder has any collaborators.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    An object containing the permissions that the current user has on this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4tagsSaySSGSgvp":{"name":"tags","abstract":"

    All tags applied to this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC29allowedSharedLinkAccessLevelsSayAA0efG0OGSgvp":{"name":"allowedSharedLinkAccessLevels","abstract":"

    Access level settings for shared links set by administrator.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC19allowedInviteeRolesSaySSGSgvp":{"name":"allowedInviteeRoles","abstract":"

    Folder collaboration roles allowed by the enterprise administrator.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17isExternallyOwnedSbSgvp":{"name":"isExternallyOwned","abstract":"

    Whether this folder is owned by a user outside of the enterprise.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11collectionsSaySDyS2SGGSgvp":{"name":"collections","abstract":"

    The collections the folder belongs to

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC14classificationAA14ClassificationCSgvp":{"name":"classification","abstract":"

    Details about the classification applied to a Box folder

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Folder"},"Classes/FileVersionRetention.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC04fileD0AA0cD0CSgvp":{"name":"fileVersion","abstract":"

    The file version this file version retention was applied to.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4fileAA0C0CSgvp":{"name":"file","abstract":"

    The file this file version retention was applied to.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC9appliedAt10Foundation4DateVSgvp":{"name":"appliedAt","abstract":"

    When this file version retention object was created.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC13dispositionAt10Foundation4DateVSgvp":{"name":"dispositionAt","abstract":"

    When the retention period expires on this file version retention.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC07winningE6PolicyAA0eG0CSgvp":{"name":"winningRetentionPolicy","abstract":"

    The winning retention policy applied to this file version retention. A file version can have multiple retention policies applied.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC2idSSvp":{"name":"id","abstract":"

    The ID of the file version legal hold object.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC04fileD0AA0cD0CSgvp":{"name":"fileVersion","abstract":"

    The file version that is held

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4fileAA0C0CSgvp":{"name":"file","abstract":"

    The parent file of the file version that is held.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC05legalF17PolicyAssignmentsSayAA0efH10AssignmentCGSgvp":{"name":"legalHoldPolicyAssignments","abstract":"

    List of assignments contributing to this hold.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    Time that this file version legal hold was deleted.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC2idSSvp":{"name":"id","abstract":"

    The ID of the file version object

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4sha1SSSgvp":{"name":"sha1","abstract":"

    The SHA-1 hash of the file.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4nameSSSgvp":{"name":"name","abstract":"

    The name of the file version

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4sizes5Int64VSgvp":{"name":"size","abstract":"

    Size of the file version in bytes

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC19uploaderDisplayNameSSSgvp":{"name":"uploaderDisplayName","abstract":"

    User’s name at the time of upload

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the file version object was created

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the file version object was last updated

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last updated the file version

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When the file version object was trashed.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9trashedByAA4UserCSgvp":{"name":"trashedBy","abstract":"

    The user who trashed the file version.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When the file version object was purged.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10restoredAt10Foundation4DateVSgvp":{"name":"restoredAt","abstract":"

    When the file version object was restored.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10restoredByAA4UserCSgvp":{"name":"restoredBy","abstract":"

    The user who restored the file version.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersion"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Permission for download

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV10canPreviewSbSgvp":{"name":"canPreview","abstract":"

    Permission for preview

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canUploadSbSgvp":{"name":"canUpload","abstract":"

    Permission for upload

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV10canCommentSbSgvp":{"name":"canComment","abstract":"

    Permission to comment

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Permission to rename

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Permission to delete

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Permission to share

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Permission to share access

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV21canInviteCollaboratorSbSgvp":{"name":"canInviteCollaborator","abstract":"

    Permission to invite collaborators

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV11canAnnotateSbSgvp":{"name":"canAnnotate","abstract":"

    Permission to annotate

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV21canViewAnnotationsAllSbSgvp":{"name":"canViewAnnotationsAll","abstract":"

    Permission to view all annotations

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV22canViewAnnotationsSelfSbSgvp":{"name":"canViewAnnotationsSelf","abstract":"

    Permission to view signed in user annotations

    ","parent_name":"Permissions"},"Classes/File/Permissions.html":{"name":"Permissions","abstract":"

    Permissions that the current user has on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11fileVersionAA0cE0CSgvp":{"name":"fileVersion","abstract":"

    The version information of the file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this file object.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4sha1SSSgvp":{"name":"sha1","abstract":"

    The SHA-1 hash of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4nameSSSgvp":{"name":"name","abstract":"

    The name of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9extensionSSSgvp":{"name":"extension","abstract":"

    Indicates the suffix, when available, on the file. By default, set to an empty string.","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11descriptionSSSgvp":{"name":"description","abstract":"

    The description of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4sizeSiSgvp":{"name":"size","abstract":"

    Size of this file in bytes.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC14pathCollectionAA04PathE0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this item, starting at the root.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC12commentCountSiSgvp":{"name":"commentCount","abstract":"

    Description

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The number of comments on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this file was last updated on the Box servers.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When this file was moved to the trash.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When this file will be permanently deleted.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC16contentCreatedAt10Foundation4DateVSgvp":{"name":"contentCreatedAt","abstract":"

    When the content of this file was created.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17contentModifiedAt10Foundation4DateVSgvp":{"name":"contentModifiedAt","abstract":"

    When the content of this file was last modified.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9isPackageSbSgvp":{"name":"isPackage","abstract":"

    Whether the file is a package. Used for Mac Packages used by iWorks.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC19uploaderDisplayNameSSSgvp":{"name":"uploaderDisplayName","abstract":"

    User’s name at the time of upload

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who first created this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last updated this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10sharedLinkAA06SharedE0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    The folder containing this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10itemStatusAA04ItemE0OSgvp":{"name":"itemStatus","abstract":"

    Whether this item is deleted or not. Values include active, trashed if the file has been moved to the trash,","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC13versionNumberSSSgvp":{"name":"versionNumber","abstract":"

    The version number of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When the file will automatically be deleted, i.e. expired.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Permissions that the current user has on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17expiringEmbedLinkAA08ExpiringeF0CSgvp":{"name":"expiringEmbedLink","abstract":"

    An expiring URL for an embedded preview session in an iframe. This URL will expire after 60 seconds and the session will expire after 60 minutes.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11collectionsSaySDyS2SGGSgvp":{"name":"collections","abstract":"

    The collections that the file belongs to

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4lockAA4LockCSgvp":{"name":"lock","abstract":"

    The lock held on this file. If there is no lock, this can either be null or have a timestamp in the past.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4tagsSaySSGSgvp":{"name":"tags","abstract":"

    All tags applied to this file

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17hasCollaborationsSbSgvp":{"name":"hasCollaborations","abstract":"

    Whether this file has any collaborators.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17isExternallyOwnedSbSgvp":{"name":"isExternallyOwned","abstract":"

    Whether this file is owned by a user outside of the enterprise.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC19allowedInviteeRolesSayAA17CollaborationRoleOGSgvp":{"name":"allowedInviteeRoles","abstract":"

    File collaboration roles allowed by the enterprise administrator.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC15representationsAA24EntryContainerInnerModelCyAA0C14RepresentationVGSgvp":{"name":"representations","abstract":"

    Digital assets created for this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC14classificationAA14ClassificationCSgvp":{"name":"classification","abstract":"

    Details about the classification applied to a Box file

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"File"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    Embed link URL

    ","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC5tokenAA5TokenCSgvp":{"name":"token","abstract":"

    Information about the token used by the embed component

    ","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ExpiringEmbedLink"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO7commentyAeA7CommentCcAEmF":{"name":"comment(_:)","abstract":"

    Comment type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO7unknownyA2EmF":{"name":"unknown","abstract":"

    Unknown type

    ","parent_name":"EventItemType"},"Classes/EventItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EventItem"},"Classes/EventItem/EventItemType.html":{"name":"EventItemType","abstract":"

    Type of the object modified by the event

    ","parent_name":"EventItem"},"Classes/EventItem.html#/s:6BoxSDK9EventItemC9itemValueAC0cD4TypeOvp":{"name":"itemValue","abstract":"

    Event item type

    ","parent_name":"EventItem"},"Classes/EventItem.html#/s:6BoxSDK9EventItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EventItem"},"Classes/EventContainer.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of events

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC7entriesSayAA0C0CGSgvp":{"name":"entries","abstract":"

    Events in a container

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC5limitSiSgvp":{"name":"limit","abstract":"

    Maximum number of events per page

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC18nextStreamPositionSSSgvp":{"name":"nextStreamPosition","abstract":"

    Defines next stream position in the stream

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC9chunkSizeSiSgvp":{"name":"chunkSize","abstract":"

    The number of event records contained in the object with entries.

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EventContainer"},"Classes/Event.html#/s:6BoxSDK5EventC4typeSSvp":{"name":"type","abstract":"

    Box event object type

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user that performed the action represented by the event. Some events may be performed by users not logged into Box.","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9eventTypeAA0cE0Ovp":{"name":"eventType","abstract":"

    One of the event types.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9sessionIdSSSgvp":{"name":"sessionId","abstract":"

    The session ID of the user who performed the action represented by the event.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC6sourceAA0C4ItemCSgvp":{"name":"source","abstract":"

    The object associated with the event.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the event occurred (when the user performed the action).

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC10recordedAt10Foundation4DateVSgvp":{"name":"recordedAt","abstract":"

    When the event was stored in the Box database.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC17additionalDetailsSDySSypGSgvp":{"name":"additionalDetails","abstract":"

    Additional details for the event

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Event"},"Classes/EntryContainerInnerModel.html#/s:6BoxSDK24EntryContainerInnerModelC7entriesSayxGSgvp":{"name":"entries","abstract":"

    Container entries

    ","parent_name":"EntryContainerInnerModel"},"Classes/Order.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC2bySSSgvp":{"name":"by","abstract":"

    Defines which parameters are items ordered by

    ","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC9directionAA0C9DirectionOSgvp":{"name":"direction","abstract":"

    Defines direction of items order - ascending or descending

    ","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Order"},"Classes/EntryContainer.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of entries

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC7entriesSayxGvp":{"name":"entries","abstract":"

    Entries in a container

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC6offsetSiSgvp":{"name":"offset","abstract":"

    Paging offset

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC10nextMarkerSSSgvp":{"name":"nextMarker","abstract":"

    Next paging marker value

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC18nextStreamPositionSSSgvp":{"name":"nextStreamPosition","abstract":"

    Next stream position

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC5limitSiSgvp":{"name":"limit","abstract":"

    Maximum number of items per page

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC5orderSayAA5OrderCGSgvp":{"name":"order","abstract":"

    Defines how entries are ordered

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC4jsonACyxGSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EntryContainer"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4typeSSvp":{"name":"type","abstract":"

    Type of Box item.

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4nameSSSgvp":{"name":"name","abstract":"

    Enterprise name

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Enterprise"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC4typeSSvp":{"name":"type","abstract":"

    Type of Box item.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC11isConfirmedSbSgvp":{"name":"isConfirmed","abstract":"

    Whether email alias is confirmed.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC5emailSSSgvp":{"name":"email","abstract":"

    User’s email address.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EmailAlias"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC2idSSvp":{"name":"id","abstract":"

    The ID of the device pinner object.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user that the device pin belongs to.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC11productNameSSSgvp":{"name":"productName","abstract":"

    The type of device being pinned.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time the device pin was created.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time the device pin was modified.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"DevicePin"},"Classes/Comment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC07isReplyC0SbSgvp":{"name":"isReplyComment","abstract":"

    Whether or not this comment is a reply to another comment.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC7messageSSSgvp":{"name":"message","abstract":"

    The comment text that the user typed.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC13taggedMessageSSSgvp":{"name":"taggedMessage","abstract":"

    The string representing the comment text with @mentions included. @mention format is @[id:username]","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    A mini user object representing the author of the comment.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time this comment was created.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The object this comment was placed on.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time this comment was last modified

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Comment"},"Classes/Collaborator/CollaboratorType.html#/s:6BoxSDK12CollaboratorC0C4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"CollaboratorType"},"Classes/Collaborator/CollaboratorType.html#/s:6BoxSDK12CollaboratorC0C4TypeO5groupyAeA5GroupCcAEmF":{"name":"group(_:)","abstract":"

    Group type

    ","parent_name":"CollaboratorType"},"Classes/Collaborator.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Collaborator"},"Classes/Collaborator/CollaboratorType.html":{"name":"CollaboratorType","abstract":"

    Type of collaborator

    ","parent_name":"Collaborator"},"Classes/Collaborator.html#/s:6BoxSDK12CollaboratorC17collaboratorValueAC0C4TypeOvp":{"name":"collaboratorValue","abstract":"

    Type of collaborator

    ","parent_name":"Collaborator"},"Classes/Collaborator.html#/s:6BoxSDK12CollaboratorC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Collaborator"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4userAA4UserCSgvp":{"name":"user","abstract":"

    The user that is exempted from the collaboration allowlist

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the enterprise.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the target object was created.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the target object was last modified.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC6domainSSSgvp":{"name":"domain","abstract":"

    The URL domain name

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC9directionAA0C9DirectionOSgvp":{"name":"direction","abstract":"

    Direction of colaboration - can be inbound, outbound or both

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the user’s enterprise.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the collaboration object was created.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the collaboration object was last modified.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC013enterpriseHasdE11AuthEnabledSbvp":{"name":"enterpriseHasTwoFactorAuthEnabled","abstract":"

    Indicator for whether the enterpise has two factor authentication enabled.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC07userHasdeF7EnabledSbvp":{"name":"userHasTwoFactorAuthenticationEnabled","abstract":"

    Indicator for whether the user has two factor authentication enabled.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC06strongE24RequiredForExternalUsersSbvp":{"name":"strongPasswordRequiredForExternalUsers","abstract":"

    Indicator for whether the current enterprise has strong password enabled for users external","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC07userHasdE0Sbvp":{"name":"userHasStrongPassword","abstract":"

    Indicator for whether the user has strong password enabled.

    ","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC10isAcceptedSbvp":{"name":"isAccepted","abstract":"

    Indicator for whether or not the Terms of Service has been accepted.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC05termseF0AA0deF0Cvp":{"name":"termsOfService","abstract":"

    The Terms of Service associated with the requirement status.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC25termsOfServiceRequirementAC05TermshiJ0Cvp":{"name":"termsOfServiceRequirement","abstract":"

    The requirements for Terms of Service part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC25strongPasswordRequirementAC06StronghI0Cvp":{"name":"strongPasswordRequirement","abstract":"

    The requirements for Strong Password part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC34twoFactorAuthenticationRequirementAC03TwohiJ0Cvp":{"name":"twoFactorAuthenticationRequirement","abstract":"

    The requirements for Two Factor Authentication part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the collaboration object.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the collaboration object was created.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the collaboration object was last modified.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When the collaboration will expire.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC6statusAA0C6StatusOSgvp":{"name":"status","abstract":"

    The status of the collaboration invitation.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC12accessibleByAA12CollaboratorCSgvp":{"name":"accessibleBy","abstract":"

    The user or group that is granted access.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4roleAA0C4RoleOSgvp":{"name":"role","abstract":"

    The level of access granted.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC14acknowledgedAt10Foundation4DateVSgvp":{"name":"acknowledgedAt","abstract":"

    When the status of the collaboration object changed to accepted or rejected.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The file or folder that access is granted to

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC11inviteEmailSSSgvp":{"name":"inviteEmail","abstract":"

    The email address used to invite an un-registered collaborator, if they are not a registered user.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC11canViewPathSbSgvp":{"name":"canViewPath","abstract":"

    Whether the “view path collaboration” feature is enabled or not.","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC28acceptanceRequirementsStatusAC010AcceptanceeF0CSgvp":{"name":"acceptanceRequirementsStatus","abstract":"

    The acceptance requirements for the user or enterprise.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Collaboration"},"Classes/Collaboration/AcceptanceRequirementsStatus.html":{"name":"AcceptanceRequirementsStatus","abstract":"

    Defines the Acceptance Requirements Status object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/TermsOfServiceRequirement.html":{"name":"TermsOfServiceRequirement","abstract":"

    Defines the Terms of Service requirement for the Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/StrongPasswordRequirement.html":{"name":"StrongPasswordRequirement","abstract":"

    Defines the Strong Password requirement for the Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html":{"name":"TwoFactorAuthenticationRequirement","abstract":"

    Defines the Two Factor Authentication Requirement for Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Classification.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC5colorSo7UIColorCSgvp":{"name":"color","abstract":"

    The color that is used to display the classification label in a user-interface

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC10definitionSSSgvp":{"name":"definition","abstract":"

    An explanation of the meaning of this classification

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC4nameSSSgvp":{"name":"name","abstract":"

    Name of the classification

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Classification"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4typeSSvp":{"name":"type","abstract":"

    Box item type - should be collection.

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4nameSSSgvp":{"name":"name","abstract":"

    Name of the collection

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC14collectionTypeSSSgvp":{"name":"collectionType","abstract":"

    The type of the collection. This is used to determine the proper visual treatment for collections.","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxCollection"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO10jsonObjectyAESDySSypGcAEmF":{"name":"jsonObject(_:)","abstract":"

    JSON body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO9jsonArrayyAESaySDySSypGGcAEmF":{"name":"jsonArray(_:)","abstract":"

    JSON Array body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO14urlencodedFormyAESDyS2SGcAEmF":{"name":"urlencodedForm(_:)","abstract":"

    URL encoded form body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO4datayAE10Foundation4DataVcAEmF":{"name":"data(_:)","abstract":"

    Data body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO9multipartyAeA13MultipartFormVcAEmF":{"name":"multipart(_:)","abstract":"

    Multipart form body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO5emptyyA2EmF":{"name":"empty","abstract":"

    Empty body

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html":{"name":"BodyType","abstract":"

    Defines body type of a request

    ","parent_name":"BoxRequest"},"Classes/PagingIterator.html#/s:6BoxSDK14PagingIteratorC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    The total count of the result set, if known

    ","parent_name":"PagingIterator"},"Classes/PagingIterator.html#/s:6BoxSDK14PagingIteratorC4next10completionyys6ResultOyAA14EntryContainerCyxGAA0A8SDKErrorCGc_tF":{"name":"next(completion:)","abstract":"

    Gets next page of elements from the iterator

    ","parent_name":"PagingIterator"},"Classes/BoxNetworkTask.html#/s:6BoxSDK0A11NetworkTaskC9cancelledSbvp":{"name":"cancelled","abstract":"

    Whether the task is cancelled or not

    ","parent_name":"BoxNetworkTask"},"Classes/BoxNetworkTask.html#/s:6BoxSDK0A11NetworkTaskC6cancelyyF":{"name":"cancel()","abstract":"

    Method to cancel a Box Network Task

    ","parent_name":"BoxNetworkTask"},"Classes/BoxNetworkAgent.html#/s:6BoxSDK0A12NetworkAgentC13configurationAcA0A16SDKConfigurationV_tcfc":{"name":"init(configuration:)","abstract":"

    Initializer.

    ","parent_name":"BoxNetworkAgent"},"Classes/BoxNetworkAgent.html#/s:6BoxSDK0A12NetworkAgentC4send7request10completionyAA0A7RequestC_ys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"send(request:completion:)","abstract":"

    Makes Box SDK request

    ","parent_name":"BoxNetworkAgent"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC4list6marker5limit6fieldsAA14PagingIteratorCyAA7WebhookCGSSSg_SiSgSaySSGSgtF":{"name":"list(marker:limit:fields:)","abstract":"

    Get all webhooks in an enterprise.

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC3get9webhookId6fields10completionySS_SaySSGSgys6ResultOyAA7WebhookCAA0A8SDKErrorCGctF":{"name":"get(webhookId:fields:completion:)","abstract":"

    Get information about a webhook.

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6update9webhookId10targetType0hG08triggers7address6fields10completionySS_SSSgALSayAA7WebhookC13EventTriggersOGSgALSaySSGSgys6ResultOyAnA0A8SDKErrorCGctF":{"name":"update(webhookId:targetType:targetId:triggers:address:fields:completion:)","abstract":"

    Update a webhook

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6create10targetType0F2Id8triggers7address6fields10completionySS_SSSayAA7WebhookC13EventTriggersOGSSSaySSGSgys6ResultOyAlA0A8SDKErrorCGctF":{"name":"create(targetType:targetId:triggers:address:fields:completion:)","abstract":"

    Create a webhook

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6delete9webhookId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(webhookId:completion:)","abstract":"

    Deletes a webhook.

    ","parent_name":"WebhooksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC3get9webLinkId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(webLinkId:fields:completion:)","abstract":"

    Get information about a specified web link.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6create3url8parentId4name11description10sharedLink6fields10completionySS_S2SSgAlA17NullableParameterOyAA06SharedM4DataVGSgSaySSGSgys6ResultOyAA0cM0CAA0A8SDKErrorCGctF":{"name":"create(url:parentId:name:description:sharedLink:fields:completion:)","abstract":"

    Creates a new web link with the specified url on the specified item.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6update9webLinkId3url06parentI04name11description06sharedH06fields10completionySS_SSSgA3mA17NullableParameterOyAA06SharedH4DataVGSgSaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"update(webLinkId:url:parentId:name:description:sharedLink:fields:completion:)","abstract":"

    Update the specified web link info.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6delete9webLinkId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(webLinkId:completion:)","abstract":"

    Delete a specified web link.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC13getSharedLink03forcH010completionySS_ys6ResultOyAA0gH0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forWebLink:completion:)","abstract":"

    Gets web link with updated shared link

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC13setSharedLink03forcH06access10unsharedAt8password11canDownload10completionySS_AA0gH6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0gH0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forWebLink:access:unsharedAt:password:canDownload:completion:)","abstract":"

    Creates or updates shared link for a web link

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC16deleteSharedLink03forcH010completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forWebLink:completion:)","abstract":"

    Removes shared link for a web link

    ","parent_name":"WebLinksModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC10getCurrent6fields10completionySaySSGSg_ys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"getCurrent(fields:completion:)","abstract":"

    Get information about the user for which this client is authenticated.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC3get6userId6fields10completionySS_SaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"get(userId:fields:completion:)","abstract":"

    Get information about a user in the enterprise. Requires enterprise administration","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC9getAvatar6userId10completionySS_ys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF":{"name":"getAvatar(userId:completion:)","abstract":"

    Get image of a user’s avatar

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6create5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0J24ExternalCollabRestricted0J22ExemptFromDeviceLimits0J27ExemptFromLoginVerification6status6fields10completionySS_SSAA8UserRoleOSgSSSgSbSgA3Zs5Int64VSgSayAA4UserC12TrackingCodeVGSgA_AZA_A_A_AA10UserStatusOSgSaySSGSgys6ResultOyA4_AA0A8SDKErrorCGctF":{"name":"create(login:name:role:language:isSyncEnabled:jobTitle:phone:address:spaceAmount:trackingCodes:canSeeManagedUsers:timezone:isExternalCollabRestricted:isExemptFromDeviceLimits:isExemptFromLoginVerification:status:fields:completion:)","abstract":"

    Create a new managed user in an enterprise. This method only works for Box admins.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6update6userId5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0L24ExternalCollabRestricted0L22ExemptFromDeviceLimits0L27ExemptFromLoginVerification6status6fields10completionySS_SSSgAxA8UserRoleOSgAXSbSgA3Xs5Int64VSgSayAA4UserC12TrackingCodeVGSgA0_AXA0_A0_A0_AA10UserStatusOSgSaySSGSgys6ResultOyA5_AA0A8SDKErrorCGctF":{"name":"update(userId:login:name:role:language:isSyncEnabled:jobTitle:phone:address:spaceAmount:trackingCodes:canSeeManagedUsers:timezone:isExternalCollabRestricted:isExemptFromDeviceLimits:isExemptFromLoginVerification:status:fields:completion:)","abstract":"

    Update the information for a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC13createAppUser4name8language8jobTitle8timezone5phone7address11spaceAmount6status26isExternalCollabRestricted013canSeeManagedC06fields10completionySS_SSSgA4Qs5Int64VSgAA0G6StatusOSgSbSgAXSaySSGSgys6ResultOyAA0G0CAA0A8SDKErrorCGctF":{"name":"createAppUser(name:language:jobTitle:timezone:phone:address:spaceAmount:status:isExternalCollabRestricted:canSeeManagedUsers:fields:completion:)","abstract":"

    Create a new app user in an enterprise.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6delete6userId6notify5force10completionySS_SbSgAIys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(userId:notify:force:completion:)","abstract":"

    Delete a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC17listForEnterprise10filterTerm6fields9usemarker6marker6offset5limitAA14PagingIteratorCyAA4UserCGSSSg_SaySSGSgSbSgAPSiSgATtF":{"name":"listForEnterprise(filterTerm:fields:usemarker:marker:offset:limit:)","abstract":"

    Returns all of the users for the Enterprise. Only available to admin accounts or service accounts.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC22inviteToJoinEnterprise5login12enterpriseId6fields10completionySS_SSSaySSGSgys6ResultOyAA6InviteCAA0A8SDKErrorCGctF":{"name":"inviteToJoinEnterprise(login:enterpriseId:fields:completion:)","abstract":"

    Invite an existing user to join an Enterprise.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC20moveItemsOwnedByUser6withID02toi4WithK06notify6fields10completionySS_SSSbSgSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"moveItemsOwnedByUser(withID:toUserWithID:notify:fields:completion:)","abstract":"

    Move all of the items owned by a user into a new folder in another user’s account.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC11changeLogin6userId5login6fields10completionySS_SSSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"changeLogin(userId:login:fields:completion:)","abstract":"

    Used to convert one of the user’s confirmed email aliases into the user’s primary login.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16listEmailAliases6userId10completionySS_ys6ResultOyAA14EntryContainerCyAA0F5AliasCGAA0A8SDKErrorCGctF":{"name":"listEmailAliases(userId:completion:)","abstract":"

    Retrieves all email aliases for this user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16createEmailAlias6userId5email10completionySS_SSys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createEmailAlias(userId:email:completion:)","abstract":"

    Adds a new email alias to the given user’s account.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16deleteEmailAlias6userId05emailgI010completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteEmailAlias(userId:emailAliasId:completion:)","abstract":"

    Removes an email alias from a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC19rollOutOfEnterprise6userId6notify6fields10completionySS_SbSgSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"rollOutOfEnterprise(userId:notify:fields:completion:)","abstract":"

    Roll a user out of their enterprise (and convert them to a standalone free user)

    ","parent_name":"UsersModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC9listItems6offset5limit6fieldsAA14PagingIteratorCyAA10FolderItemOGSiSg_AMSaySSGSgtF":{"name":"listItems(offset:limit:fields:)","abstract":"

    Gets the files, folders and web links that are in the user’s trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC7getFile2id6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getFile(id:fields:completion:)","abstract":"

    Get a file that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC9getFolder2id6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getFolder(id:fields:completion:)","abstract":"

    Get a folder that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC10getWebLink2id6fields10completionySS_SaySSGSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getWebLink(id:fields:completion:)","abstract":"

    Get a web link that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC11restoreFile2id4name14parentFolderId6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"restoreFile(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a file that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC13restoreFolder2id4name06parentF2Id6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"restoreFolder(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a folder that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC14restoreWebLink2id4name14parentFolderId6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"restoreWebLink(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a web link that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC21permanentlyDeleteFile2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteFile(id:completion:)","abstract":"

    Permanently delete a file that is in the trash. The file will no longer exist in Box.","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC23permanentlyDeleteFolder2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteFolder(id:completion:)","abstract":"

    Permanently delete a folder that is in the trash. The folder will no longer exist","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC24permanentlyDeleteWebLink2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteWebLink(id:completion:)","abstract":"

    Permanently delete a web link that is in the trash. The web link will no longer exist","parent_name":"TrashModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6create6status7tosType4text6fields10completionyAA0cD13ServiceStatusO_AA0cdnJ0OSSSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF":{"name":"create(status:tosType:text:fields:completion:)","abstract":"

    Creates a Terms of Service for an enterprise.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6update5tosId4text6status6fields10completionySS_SSAA0cD13ServiceStatusOSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF":{"name":"update(tosId:text:status:fields:completion:)","abstract":"

    Updates a specified Terms of Service.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC3get5tosId6fields10completionySS_SaySSGSgys6ResultOyAA0cD7ServiceCAA0A8SDKErrorCGctF":{"name":"get(tosId:fields:completion:)","abstract":"

    Retrieves a specified Terms of Service.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC17listForEnterprise7tosType6fields10completionyAA0cd7ServiceK0OSg_SaySSGSgys6ResultOySayAA0cdN0CGAA0A8SDKErrorCGctF":{"name":"listForEnterprise(tosType:fields:completion:)","abstract":"

    Retrieves both external and managed Terms of Services if no Terms of Service type is specified.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16createUserStatus5tosId10isAccepted04userK06fields10completionySS_SbSSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"createUserStatus(tosId:isAccepted:userId:fields:completion:)","abstract":"

    Creates an association between a terms of service and a specified user. If no user is specified, defaults to current user.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16updateUserStatus04userI2Id10isAccepted6fields10completionySS_SbSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"updateUserStatus(userStatusId:isAccepted:fields:completion:)","abstract":"

    Update the user status on the Terms of Service. Choose to either accept or deny.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC13getUserStatus5tosId04userK06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"getUserStatus(tosId:userId:fields:completion:)","abstract":"

    Retrieves the user status for the specified Terms of Service and the specified user.

    ","parent_name":"TermsOfServicesModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC3get6taskId6fields10completionySS_SaySSGSgys6ResultOyAA4TaskCAA0A8SDKErrorCGctF":{"name":"get(taskId:fields:completion:)","abstract":"

    Fetches a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6create6fileId6action7message5dueAt14completionRule6fields0L0ySS_AA10TaskActionOSSSg10Foundation4DateVSgAA0o10CompletionM0OSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"create(fileId:action:message:dueAt:completionRule:fields:completion:)","abstract":"

    Used to create a single task for single user on a single file.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6update6taskId6action7message5dueAt14completionRule6fields0L0ySS_AA10TaskActionOSSSg10Foundation4DateVSgAA0o10CompletionM0OSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"update(taskId:action:message:dueAt:completionRule:fields:completion:)","abstract":"

    Updates a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6delete6taskId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(taskId:completion:)","abstract":"

    Permanently deletes a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC13getAssignment04taskF2Id6fields10completionySS_SaySSGSgys6ResultOyAA04TaskF0CAA0A8SDKErrorCGctF":{"name":"getAssignment(taskAssignmentId:fields:completion:)","abstract":"

    Fetches a specific task assignment.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6assign6taskId04userG06fields10completionySS_SSSaySSGSgys6ResultOyAA14TaskAssignmentCAA0A8SDKErrorCGctF":{"name":"assign(taskId:userId:fields:completion:)","abstract":"

    Used to assign a task to a single user identified by userId.","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC13assignByEmail6taskId5email6fields10completionySS_SSSaySSGSgys6ResultOyAA14TaskAssignmentCAA0A8SDKErrorCGctF":{"name":"assignByEmail(taskId:email:fields:completion:)","abstract":"

    Used to assign a task to a single user identified by login.","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC16updateAssignment04taskF2Id7message15resolutionState10completionySS_SSSgAA0fK0OSgys6ResultOyAA04TaskF0CAA0A8SDKErrorCGctF":{"name":"updateAssignment(taskAssignmentId:message:resolutionState:completion:)","abstract":"

    Used to update a task assignment.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC16deleteAssignment04taskF2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteAssignment(taskAssignmentId:completion:)","abstract":"

    Permanently deletes a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC15listAssignments9forTaskId10completionySS_ys6ResultOySayAA0H10AssignmentCGAA0A8SDKErrorCGctF":{"name":"listAssignments(forTaskId:completion:)","abstract":"

    Fetches a all task assignments for particular task.

    ","parent_name":"TasksModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC3get15storagePolicyId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(storagePolicyId:fields:completion:)","abstract":"

    Get information about a storage policy.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC17listForEnterprise6marker5limit6fieldsAA14PagingIteratorCyAA0C6PolicyCGSSSg_SiSgSaySSGSgtF":{"name":"listForEnterprise(marker:limit:fields:)","abstract":"

    Get all of the storage policies in an enterprise.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC13getAssignment013storagePolicyG2Id6fields10completionySS_SaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF":{"name":"getAssignment(storagePolicyAssignmentId:fields:completion:)","abstract":"

    Get storage policy assignment information.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC15listAssignments15resolvedForType0hI2Id6fields10completionySS_SSSaySSGSgys6ResultOyAA0C16PolicyAssignmentCAA0A8SDKErrorCGctF":{"name":"listAssignments(resolvedForType:resolvedForId:fields:completion:)","abstract":"

    Get the storage policy assignment assigned to a user or enterprise.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC6assign15storagePolicyId14assignedToType0jkI06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cH10AssignmentCAA0A8SDKErrorCGctF":{"name":"assign(storagePolicyId:assignedToType:assignedToId:fields:completion:)","abstract":"

    Create storage policy assignment.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC11forceAssign15storagePolicyId14assignedToType0klJ06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cI10AssignmentCAA0A8SDKErrorCGctF":{"name":"forceAssign(storagePolicyId:assignedToType:assignedToId:fields:completion:)","abstract":"

    Assign policy

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16updateAssignment013storagePolicyG2Id0hiJ06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF":{"name":"updateAssignment(storagePolicyAssignmentId:storagePolicyId:fields:completion:)","abstract":"

    Update storage policy assignment.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16deleteAssignment013storagePolicyG2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteAssignment(storagePolicyAssignmentId:completion:)","abstract":"

    Deleting a storage policy assignment means the user will inherit the Enterprise’s default storage policy.

    ","parent_name":"StoragePoliciesModule"},"Classes/SharedItemsModule.html#/s:6BoxSDK17SharedItemsModuleC3get13sharedLinkURL0gH8Password6fields10completionySS_SSSgSaySSGSgys6ResultOyAA0C4ItemCAA0A8SDKErrorCGctF":{"name":"get(sharedLinkURL:sharedLinkPassword:fields:completion:)","abstract":"

    Get the item back from the shared link.

    ","parent_name":"SharedItemsModule"},"Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC5queryAD5scope14fileExtensions12createdAfter0I6Before07updatedJ00lK011sizeAtLeast0mN4Most12ownerUserIDs014ancestorFolderS08searchIn8itemType0V5Trash14metadataFilter6fields6offset5limitAA14PagingIteratorCyAA0U4ItemOGSSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA8_A8_A8_s5Int64VSgA11_A4_A4_SayAA0c7ContentY0OGSgAA0c4ItemY0OSgSbSgAA08MetadataC6FilterCSgA4_SiSgA23_tF":{"name":"query(query:scope:fileExtensions:createdAfter:createdBefore:updatedAfter:updatedBefore:sizeAtLeast:sizeAtMost:ownerUserIDs:ancestorFolderIDs:searchIn:itemType:searchTrash:metadataFilter:fields:offset:limit:)","abstract":"

    Searches for items in Box.

    ","parent_name":"SearchModule"},"Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC20queryWithSharedLinks0E05scope14fileExtensions12createdAfter0L6Before07updatedM00oN011sizeAtLeast0pQ4Most12ownerUserIDs014ancestorFolderV08searchIn8itemType0Y5Trash14metadataFilter6fields6offset5limitAA14PagingIteratorCyAA0C6ResultCGSSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA9_A9_A9_s5Int64VSgA12_A5_A5_SayAA0C11ContentTypeOGSgAA0C8ItemTypeOSgSbSgAA08MetadataC6FilterCSgA5_SiSgA24_tF":{"name":"queryWithSharedLinks(query:scope:fileExtensions:createdAfter:createdBefore:updatedAfter:updatedBefore:sizeAtLeast:sizeAtMost:ownerUserIDs:ancestorFolderIDs:searchIn:itemType:searchTrash:metadataFilter:fields:offset:limit:)","abstract":"

    Searches for items in Box, including items that a user might have accessed recently through a shared link.

    ","parent_name":"SearchModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC3get8policyId10completionySS_ys6ResultOyAA0C6PolicyCAA0A8SDKErrorCGctF":{"name":"get(policyId:completion:)","abstract":"

    Retrieves information about a retention policy

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6create4name4type6length17dispositionAction014canOwnerExtendC017areOwnersNotified28customNotificationRecipients10completionySS_AA0C10PolicyTypeOSiSgAA011DispositionK0OSbSgARSayAA4UserCGSgys6ResultOyAA0cV0CAA0A8SDKErrorCGctF":{"name":"create(name:type:length:dispositionAction:canOwnerExtendRetention:areOwnersNotified:customNotificationRecipients:completion:)","abstract":"

    Creates a new retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6update8policyId4name17dispositionAction6status10completionySS_SSSgAA011DispositionK0OSgAA0C12PolicyStatusOSgys6ResultOyAA0cO0CAA0A8SDKErrorCGctF":{"name":"update(policyId:name:dispositionAction:status:completion:)","abstract":"

    Updates existing retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC4list4name4type15createdByUserId6marker5limitAA14PagingIteratorCyAA0C11PolicyEntryCGSSSg_AA0cQ4TypeOSgA2OSiSgtF":{"name":"list(name:type:createdByUserId:marker:limit:)","abstract":"

    Retrieves all of the retention policies for the given enterprise.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC13getAssignment12assignmentId10completionySS_ys6ResultOyAA0c6PolicyG0CAA0A8SDKErrorCGctF":{"name":"getAssignment(assignmentId:completion:)","abstract":"

    Retrieves information about a retention policy assignment.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6assign8policyId015assignedContentH00fJ4Type12filterFields10completionySS_SSAA0c20PolicyAssignmentItemK0OSayAA19MetadataFieldFilterVGSgys6ResultOyAA0coP0CAA0A8SDKErrorCGctF":{"name":"assign(policyId:assignedContentId:assignContentType:filterFields:completion:)","abstract":"

    Creates new retention policy assignment to a content.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC15listAssignments8policyId4type6marker5limitAA14PagingIteratorCyAA0C16PolicyAssignmentCGSS_AA0cO4TypeOSgSSSgSiSgtF":{"name":"listAssignments(policyId:type:marker:limit:)","abstract":"

    Returns a list of all retention policy assignments associated with a specified retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RecentItemsModule.html#/s:6BoxSDK17RecentItemsModuleC4list6marker5limit6fieldsAA14PagingIteratorCyAA0C4ItemCGSSSg_SiSgSaySSGSgtF":{"name":"list(marker:limit:fields:)","abstract":"

    Get recent items.

    ","parent_name":"RecentItemsModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list9forFileId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF":{"name":"list(forFileId:completion:)","abstract":"

    Retrieve all metadata associated with a given file

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"get(forFileWithId:scope:templateKey:completion:)","abstract":"

    Get the metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create13forFileWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"create(forFileWithId:scope:templateKey:keys:completion:)","abstract":"

    Create a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update13forFileWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"update(forFileWithId:scope:templateKey:operations:completion:)","abstract":"

    Update a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(forFileWithId:scope:templateKey:completion:)","abstract":"

    Delete a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list11forFolderId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF":{"name":"list(forFolderId:completion:)","abstract":"

    Retrieve all metadata associated with a given folder

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"get(forFolderWithId:scope:templateKey:completion:)","abstract":"

    Get the metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create15forFolderWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"create(forFolderWithId:scope:templateKey:keys:completion:)","abstract":"

    Create a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update15forFolderWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"update(forFolderWithId:scope:templateKey:operations:completion:)","abstract":"

    Update a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(forFolderWithId:scope:templateKey:completion:)","abstract":"

    Delete a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC16getTemplateByKey5scope08templateH010completionySS_SSys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"getTemplateByKey(scope:templateKey:completion:)","abstract":"

    Get metadata template by name (templateKey).

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC15getTemplateById2id10completionySS_ys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"getTemplateById(id:completion:)","abstract":"

    Get metadata template by ID.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14createTemplate5scope11templateKey11displayName6hidden22copyInstanceOnItemCopy6fields10completionySS_S2SS2bSgSayAA0C5FieldVGys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"createTemplate(scope:templateKey:displayName:hidden:copyInstanceOnItemCopy:fields:completion:)","abstract":"

    Create metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14updateTemplate5scope11templateKey9operation10completionySS_SSAA0cF9OperationOys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"updateTemplate(scope:templateKey:operation:completion:)","abstract":"

    Update metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14deleteTemplate5scope11templateKey10completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteTemplate(scope:templateKey:completion:)","abstract":"

    Delete metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC23listEnterpriseTemplates5scope6marker5limitAA14PagingIteratorCyAA0C8TemplateCGSS_SSSgSiSgtF":{"name":"listEnterpriseTemplates(scope:marker:limit:)","abstract":"

    Retrieve all metadata templates within the specified enterprise

    ","parent_name":"MetadataModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC4list8folderId015ownerEnterpriseI06fields6marker5limitAA14PagingIteratorCyAA0cdE0CGSS_SSSgSaySSGSgAOSiSgtF":{"name":"list(folderId:ownerEnterpriseId:fields:marker:limit:)","abstract":"

    Retrieve an iterator for available metadata cascade policies within a given folder for the current enterprise.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC3get2id6fields10completionySS_SaySSGSgys6ResultOyAA0cdE0CAA0A8SDKErrorCGctF":{"name":"get(id:fields:completion:)","abstract":"

    Get information about a specific metadata cascade policy.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC6create8folderId5scope11templateKey6fields10completionySS_AA0C5ScopeOSSSaySSGSgys6ResultOyAA0cdE0CAA0A8SDKErrorCGctF":{"name":"create(folderId:scope:templateKey:fields:completion:)","abstract":"

    Create a metadata cascade policy that applies to a given folder and a metadata instance attached to the given folder.","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC6delete2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(id:completion:)","abstract":"

    Delete a metadata cascade policy that applies to a given folder and a folder-attached instance of given template.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC10forceApply2id18conflictResolution10completionySS_AA08ConflictK0Oys6ResultOyytAA0A8SDKErrorCGctF":{"name":"forceApply(id:conflictResolution:completion:)","abstract":"

    If a policy already exists on a folder, this will apply that policy to all existing files and sub-folders within the target folder.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC3get8policyId6fields10completionySS_SaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"get(policyId:fields:completion:)","abstract":"

    Get information about a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6create10policyName11description15filterStartedAt0j5EndedL09isOngoing6fields10completionySS_SSSg10Foundation4DateVSgAPSbSgSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"create(policyName:description:filterStartedAt:filterEndedAt:isOngoing:fields:completion:)","abstract":"

    Create a new legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6update8policyId0G4Name11description12releaseNotes6fields10completionySS_SSSgA2KSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"update(policyId:policyName:description:releaseNotes:fields:completion:)","abstract":"

    Update a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6delete8policyId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(policyId:completion:)","abstract":"

    Deletes a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC17listForEnterprise10policyName6marker5limit6fieldsAA14PagingIteratorCyAA0C10HoldPolicyCGSSSg_ANSiSgSaySSGSgtF":{"name":"listForEnterprise(policyName:marker:limit:fields:)","abstract":"

    Get all of the legal hold policies for the enterprise.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC19getPolicyAssignment12assignmentId6fields10completionySS_SaySSGSgys6ResultOyAA0c4HoldgH0CAA0A8SDKErrorCGctF":{"name":"getPolicyAssignment(assignmentId:fields:completion:)","abstract":"

    Get information about a policy assignmnet.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC12assignPolicy8policyId0f2ToI00fJ4Type6fields10completionySS_S2SSaySSGSgys6ResultOyAA0c4HoldG10AssignmentCAA0A8SDKErrorCGctF":{"name":"assignPolicy(policyId:assignToId:assignToType:fields:completion:)","abstract":"

    Assign a legal hold to a file, file version, folder, or user.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC22deletePolicyAssignment12assignmentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deletePolicyAssignment(assignmentId:completion:)","abstract":"

    Sends a request to delete an existing policy assignment.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC21listPolicyAssignments8policyId12assignToType0klJ06marker5limit6fieldsAA14PagingIteratorCyAA0c4HoldG10AssignmentCGSS_SSSgA2PSiSgSaySSGSgtF":{"name":"listPolicyAssignments(policyId:assignToType:assignToId:marker:limit:fields:)","abstract":"

    Get all of the assignments for a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC20getFileVersionPolicy11legalHoldId6fields10completionySS_SaySSGSgys6ResultOyAA0ghcK0CAA0A8SDKErrorCGctF":{"name":"getFileVersionPolicy(legalHoldId:fields:completion:)","abstract":"

    Get information about a file version legal hold.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC23listFileVersionPolicies8policyId6marker5limit6fieldsAA14PagingIteratorCyAA0ghC4HoldCGSS_SSSgSiSgSaySSGSgtF":{"name":"listFileVersionPolicies(policyId:marker:limit:fields:)","abstract":"

    Get all of the non-deleted legal holds for a single legal hold policy

    ","parent_name":"LegalHoldsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC3get7groupId6fields10completionySS_SaySSGSgys6ResultOyAA5GroupCAA0A8SDKErrorCGctF":{"name":"get(groupId:fields:completion:)","abstract":"

    Retrieves a specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6create4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityM06fields10completionySS_SSSgA2mA017GroupInvitabilityM0OSgAA0r6MemberoM0OSgSaySSGSgys6ResultOyAA0R0CAA0A8SDKErrorCGctF":{"name":"create(name:provenance:externalSyncIdentifier:description:invitabilityLevel:memberViewabilityLevel:fields:completion:)","abstract":"

    Creates a new Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6update7groupId4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityO06fields10completionySS_SSSgAA17NullableParameterOySSGSgA2rA017GroupInvitabilityO0OSgAA0v6MemberqO0OSgSaySSGSgys6ResultOyAA0V0CAA0A8SDKErrorCGctF":{"name":"update(groupId:name:provenance:externalSyncIdentifier:description:invitabilityLevel:memberViewabilityLevel:fields:completion:)","abstract":"

    Updates the specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6delete7groupId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(groupId:completion:)","abstract":"

    Deletes the specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17listForEnterprise4name6offset5limit6fieldsAA14PagingIteratorCyAA5GroupCGSSSg_SiSgAOSaySSGSgtF":{"name":"listForEnterprise(name:offset:limit:fields:)","abstract":"

    Get all Groups for an enterprise.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17getMembershipInfo12membershipId6fields10completionySS_SaySSGSgys6ResultOyAA05GroupF0CAA0A8SDKErrorCGctF":{"name":"getMembershipInfo(membershipId:fields:completion:)","abstract":"

    Retrieves a specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16createMembership6userId05groupH04role22configurablePermission6fields10completionySS_SSAA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableL4DataVGSgSaySSGSgys6ResultOyAA0oF0CAA0A8SDKErrorCGctF":{"name":"createMembership(userId:groupId:role:configurablePermission:fields:completion:)","abstract":"

    Creates a Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16updateMembership12membershipId4role22configurablePermission6fields10completionySS_AA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableK4DataVGSgSaySSGSgys6ResultOyAA0nF0CAA0A8SDKErrorCGctF":{"name":"updateMembership(membershipId:role:configurablePermission:fields:completion:)","abstract":"

    Updates the specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16deleteMembership12membershipId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteMembership(membershipId:completion:)","abstract":"

    Deletes the specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC15listMemberships7groupId6offset5limit6fieldsAA14PagingIteratorCyAA15GroupMembershipCGSS_SiSgANSaySSGSgtF":{"name":"listMemberships(groupId:offset:limit:fields:)","abstract":"

    Get all Memberships for a specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC22listMembershipsForUser6userId6offset5limit6fieldsAA14PagingIteratorCyAA15GroupMembershipCGSS_SiSgANSaySSGSgtF":{"name":"listMembershipsForUser(userId:offset:limit:fields:)","abstract":"

    Returns all of the group memberships for a given user. Note this is only available to group admins.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC18listCollaborations7groupId6offset5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SiSgANSaySSGSgtF":{"name":"listCollaborations(groupId:offset:limit:fields:)","abstract":"

    Returns all of the group collaborations for a given group. Note this is only available to group admins.

    ","parent_name":"GroupsModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC3get8folderId6fields10completionySS_SaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"get(folderId:fields:completion:)","abstract":"

    Get information about a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listItems8folderId9usemarker6marker6offset5limit4sort9direction6fieldsAA14PagingIteratorCyAA10FolderItemOGSS_SbSgSSSgSiSgAtA0rF7OrderByOSgAA0T9DirectionOSgSaySSGSgtF":{"name":"listItems(folderId:usemarker:marker:offset:limit:sort:direction:fields:)","abstract":"

    Gets all of the files, folders, or web links contained within a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6create4name8parentId6fields10completionySS_SSSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"create(name:parentId:fields:completion:)","abstract":"

    Create a new folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6update8folderId4name11description06parentG010sharedLink0F17UploadEmailAccess4tags18canNonOwnersInvite37isCollaborationRestrictedToEnterprise11collections6fields10completionySS_SSSgA2qA17NullableParameterOyAA06SharedL4DataVGSgAA06FoldermnO0OSgSaySSGSgSbSgA1_A0_A0_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"update(folderId:name:description:parentId:sharedLink:folderUploadEmailAccess:tags:canNonOwnersInvite:isCollaborationRestrictedToEnterprise:collections:fields:completion:)","abstract":"

    Update a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6delete8folderId9recursive10completionySS_SbSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(folderId:recursive:completion:)","abstract":"

    Delete a folder or move a folder to the trash. The recursive parameter must be included in","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC4copy8folderId19destinationFolderID4name6fields10completionySS_S2SSgSaySSGSgys6ResultOyAA0I0CAA0A8SDKErrorCGctF":{"name":"copy(folderId:destinationFolderID:name:fields:completion:)","abstract":"

    Used to create a copy of a folder in another folder. The original version of the folder will not be altered.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC18listCollaborations8folderId6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SaySSGSgtF":{"name":"listCollaborations(folderId:fields:)","abstract":"

    Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14addToFavorites8folderId10completionySS_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"addToFavorites(folderId:completion:)","abstract":"

    Add folder to favorites

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC15addToCollection8folderId010collectionI010completionySS_SSys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"addToCollection(folderId:collectionId:completion:)","abstract":"

    Add folder to particular collection

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC19removeFromFavorites8folderId10completionySS_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"removeFromFavorites(folderId:completion:)","abstract":"

    Remove folder from favorites

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC20removeFromCollection8folderId010collectionI010completionySS_SSys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"removeFromCollection(folderId:collectionId:completion:)","abstract":"

    Add folder to particular collection

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13getSharedLink9forFolder10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forFolder:completion:)","abstract":"

    Gets folder with updated shared link

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13setSharedLink9forFolder6access10unsharedAt8password11canDownload10completionySS_AA0fG6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forFolder:access:unsharedAt:password:canDownload:completion:)","abstract":"

    Creates or updates shared link for a folder

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC16deleteSharedLink9forFolder10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forFolder:completion:)","abstract":"

    Removes shared link for a folder

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC12getWatermark8folderId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getWatermark(folderId:completion:)","abstract":"

    Retrieves the watermark on a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14applyWatermark8folderId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"applyWatermark(folderId:completion:)","abstract":"

    Apply or update the watermark on a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC15removeWatermark8folderId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"removeWatermark(folderId:completion:)","abstract":"

    Remove the watermark from a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listLocks8folderIdAA14PagingIteratorCyAA10FolderLockCGSS_tF":{"name":"listLocks(folderId:)","abstract":"

    Get all of the locks on a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10createLock8folderId10completionySS_ys6ResultOyAA06FolderF0CAA0A8SDKErrorCGctF":{"name":"createLock(folderId:completion:)","abstract":"

    Creates a folder lock on a folder, preventing it from being moved and/or deleted.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10deleteLock06folderF2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteLock(folderLockId:completion:)","abstract":"

    Remove the specified folder lock.

    ","parent_name":"FoldersModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC3get6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"get(fileId:fields:completion:)","abstract":"

    Get information about a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6update6fileId4name11description06parentG010sharedLink4tags11collections4lock7ifMatch6fields10completionySS_SSSgA2pA17NullableParameterOyAA06SharedL4DataVGSgSaySSGSgAxRyAA04LockW0VGSgApXys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"update(fileId:name:description:parentId:sharedLink:tags:collections:lock:ifMatch:fields:completion:)","abstract":"

    Update the information about a file, including renaming or moving the file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4copy6fileId06parentG04name7version6fields10completionySS_S2SSgAKSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"copy(fileId:parentId:name:version:fields:completion:)","abstract":"

    Create a copy of a file in another folder. The original version of the file will not be","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6upload4data4name8parentId8progress21performPreflightCheck10completionAA0A10UploadTaskC10Foundation4DataV_S2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"upload(data:name:parentId:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13uploadVersion7forFile4name17contentModifiedAt4data7ifMatch8progress21performPreflightCheck10completionAA0A10UploadTaskCSS_SSSgAO10Foundation4DataVAOySo10NSProgressCcSbys6ResultOyAA0H0CAA0A8SDKErrorCGctF":{"name":"uploadVersion(forFile:name:contentModifiedAt:data:ifMatch:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12streamUpload0E08fileSize4name8parentId8progress21performPreflightCheck10completionAA0aF4TaskCSo13NSInputStreamC_SiS2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"streamUpload(stream:fileSize:name:parentId:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19streamUploadVersion0E08fileSize7forFile4name17contentModifiedAt7ifMatch8progress21performPreflightCheck10completionAA0aF4TaskCSo13NSInputStreamC_SiS3SSgARySo10NSProgressCcSbys6ResultOyAA0K0CAA0A8SDKErrorCGctF":{"name":"streamUploadVersion(stream:fileSize:forFile:name:contentModifiedAt:ifMatch:progress:performPreflightCheck:completion:)","abstract":"

    Upload a new version of an existing file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14preflightCheck4name8parentId4size10completionAA0A11NetworkTaskCSS_SSs5Int64VSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"preflightCheck(name:parentId:size:completion:)","abstract":"

    Verifies that new file will be accepted by Box before you send all the bytes over the wire.","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC27preflightCheckForNewVersion7forFile4name4size10completionAA0A11NetworkTaskCSS_SSSgs5Int64VSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"preflightCheckForNewVersion(forFile:name:size:completion:)","abstract":"

    Verifies that an updated file will be accepted by Box before you send all the bytes over the wire. It’s used before","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4lock6fileId9expiresAt19isDownloadPrevented6fields10completionySS_10Foundation4DateVSgSbSgSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"lock(fileId:expiresAt:isDownloadPrevented:fields:completion:)","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6unlock6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"unlock(fileId:fields:completion:)","abstract":"

    Unlock a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getThumbnail7forFile9extension9minHeight0J5Width03maxK00mL010completionySS_AA0F9ExtensionOSiSgA3Nys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF":{"name":"getThumbnail(forFile:extension:minHeight:minWidth:maxHeight:maxWidth:completion:)","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getEmbedLink7forFile10completionySS_ys6ResultOyAA08ExpiringfG0CAA0A8SDKErrorCGctF":{"name":"getEmbedLink(forFile:completion:)","abstract":"

    Get a URL for creating an embedded preview session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC18listCollaborations7forFile6marker5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SSSgSiSgSaySSGSgtF":{"name":"listCollaborations(forFile:marker:limit:fields:)","abstract":"

    Get all of the collaborations on a file (i.e. all of the users that have access to that file).

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listComments7forFile6offset5limit6fieldsAA14PagingIteratorCyAA7CommentCGSS_SiSgANSaySSGSgtF":{"name":"listComments(forFile:offset:limit:fields:)","abstract":"

    Get all of the comments on a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC9listTasks7forFile6fieldsAA14PagingIteratorCyAA4TaskCGSS_SaySSGSgtF":{"name":"listTasks(forFile:fields:)","abstract":"

    Get all of the tasks for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC8download6fileId14destinationURL7version8progress10completionAA0A12DownloadTaskCSS_10Foundation0I0VSSSgySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"download(fileId:destinationURL:version:progress:completion:)","abstract":"

    Download a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6delete6fileId7ifMatch10completionySS_SSSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(fileId:ifMatch:completion:)","abstract":"

    Discards a file to the trash. The etag of the file can be included as an ‘If-Match’ header to prevent race conditions.","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14addToFavorites6fileId10completionySS_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"addToFavorites(fileId:completion:)","abstract":"

    Add file to favorites

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15addToCollection6fileId010collectionI010completionySS_SSys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"addToCollection(fileId:collectionId:completion:)","abstract":"

    Add file to particular collection

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19removeFromFavorites6fileId10completionySS_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"removeFromFavorites(fileId:completion:)","abstract":"

    Remove file from favorites

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC20removeFromCollection6fileId010collectionI010completionySS_SSys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"removeFromCollection(fileId:collectionId:completion:)","abstract":"

    Add file to particular collection

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listVersions6fileId6offset5limit6fieldsAA14PagingIteratorCyAA11FileVersionCGSS_SiSgANSaySSGSgtF":{"name":"listVersions(fileId:offset:limit:fields:)","abstract":"

    Retrieves all file versions on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10getVersion6fileId0gfH06fields10completionySS_SSSaySSGSgys6ResultOyAA04FileF0CAA0A8SDKErrorCGctF":{"name":"getVersion(fileId:fileVersionId:fields:completion:)","abstract":"

    Retrieves a specified file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14promoteVersion6fileId0gfH06fields10completionySS_SSSaySSGSgys6ResultOyAA04FileF0CAA0A8SDKErrorCGctF":{"name":"promoteVersion(fileId:fileVersionId:fields:completion:)","abstract":"

    Promotes the specified file version to the current file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13deleteVersion6fileId0gfH07ifMatch10completionySS_S2SSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteVersion(fileId:fileVersionId:ifMatch:completion:)","abstract":"

    Discards the specified file version to the trash.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getWatermark6fileId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getWatermark(fileId:completion:)","abstract":"

    Retrieves the watermark on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14applyWatermark6fileId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"applyWatermark(fileId:completion:)","abstract":"

    Apply or update the watermark on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15removeWatermark6fileId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"removeWatermark(fileId:completion:)","abstract":"

    Remove the watermark from a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13getSharedLink7forFile10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forFile:completion:)","abstract":"

    Gets file with updated shared link

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13setSharedLink7forFile10unsharedAt6access8password11canDownload10completionySS_AA17NullableParameterOy10Foundation4DateVGSgAA0fG6AccessOSgALySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forFile:unsharedAt:access:password:canDownload:completion:)","abstract":"

    Creates of updates shared link for a file

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16deleteSharedLink7forFile10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forFile:completion:)","abstract":"

    Removes shared link for a file

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11downloadZip4name5items14destinationURL10completionySS_SayAA0F12DownloadItemVG10Foundation0J0Vys6ResultOyAA0fL6StatusCAA0A8SDKErrorCGctF":{"name":"downloadZip(name:items:destinationURL:completion:)","abstract":"

    Creates a zip of multiple files and folders and downloads it.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19createUploadSession8folderId8fileName0J4Size10completionySS_SSs5Int32Vys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createUploadSession(folderId:fileName:fileSize:completion:)","abstract":"

    Create an upload session for uploading a new file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC32createUploadSessionForNewVersion6ofFile8fileName0M4Size10completionySS_SSSgs5Int32Vys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createUploadSessionForNewVersion(ofFile:fileName:fileSize:completion:)","abstract":"

    Create an upload session for uploading a new file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10uploadPart9sessionId4data6offset9totalSize8progress10completionAA0A10UploadTaskCSS_10Foundation4DataVS2iySo10NSProgressCcys6ResultOyAA0oF0CAA0A8SDKErrorCGctF":{"name":"uploadPart(sessionId:data:offset:totalSize:progress:completion:)","abstract":"

    Upload a part of the file to this session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC22listUploadSessionParts9sessionId6offset5limitAA14PagingIteratorCyAA0F15PartDescriptionVGSS_SiSgAMtF":{"name":"listUploadSessionParts(sessionId:offset:limit:)","abstract":"

    Get list of parts of chunked upload session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12commitUpload9sessionId5parts4sha111description10sharedLink4tags11collections4lock16contentCreatedAt0q8ModifiedS010completionySS_SayAA0F15PartDescriptionVGS2SSgAA06SharedM4DataVSgSaySSGSgAxA04LockY0VSg10Foundation4DateVSgA3_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"commitUpload(sessionId:parts:sha1:description:sharedLink:tags:collections:lock:contentCreatedAt:contentModifiedAt:completion:)","abstract":"

    Commit upload session after successful upload of all parts.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11abortUpload9sessionId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"abortUpload(sessionId:completion:)","abstract":"

    Abort chunked upload session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16getUploadSession9sessionId10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getUploadSession(sessionId:completion:)","abstract":"

    Get chunked upload session with ID.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19listRepresentations6fileId18representationHint10completionySS_AA018FileRepresentationJ0OSgys6ResultOySayAA0lM0VGAA0A8SDKErrorCGctF":{"name":"listRepresentations(fileId:representationHint:completion:)","abstract":"

    Get representations for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC24getRepresentationContent6fileId18representationHint9assetPath14destinationURL8progress10completionySS_AA04FilefK0OSS10Foundation0O0VySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"getRepresentationContent(fileId:representationHint:assetPath:destinationURL:progress:completion:)","abstract":"

    Get particular representation for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC22downloadRepresentation9sourceURL011destinationH08progress10completionAA0A12DownloadTaskC10Foundation0H0V_AMySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"downloadRepresentation(sourceURL:destinationURL:progress:completion:)","abstract":"

    Download a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19getVersionRetention11retentionId10completionySS_ys6ResultOyAA04FilefG0CAA0A8SDKErrorCGctF":{"name":"getVersionRetention(retentionId:completion:)","abstract":"

    Retrieves information about a file version retention policy.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC21listVersionRetentions6fileId0hfI006policyI017dispositionAction0K6Before0K5After5limit6markerAA14PagingIteratorCyAA04FileF9RetentionCGSSSg_A2rA011DispositionL0OSg10Foundation4DateVSgAYSiSgARtF":{"name":"listVersionRetentions(fileId:fileVersionId:policyId:dispositionAction:dispositionBefore:dispositionAfter:limit:marker:)","abstract":"

    Retrieves all file version retentions for the given enterprise.

    ","parent_name":"FilesModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC07getUserC010streamType0G8Position5limitAA14PagingIteratorCyAA5EventCGAA06StreamH0OSg_AA0nI0OSgSiSgtF":{"name":"getUserEvents(streamType:streamPosition:limit:)","abstract":"

    Gets events for the current user associated with the access token.","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC013getEnterpriseC010eventTypes12createdAfter0I6Before14streamPosition5limitAA14PagingIteratorCyAA5EventCGSayAA0Q4TypeOGSg_10Foundation4DateVSgAvA06StreamM0OSgSiSgtF":{"name":"getEnterpriseEvents(eventTypes:createdAfter:createdBefore:streamPosition:limit:)","abstract":"

    Gets events for all users and content in the enterprise. Enterprise events are accessible for one year via the API,","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC13getPollingURL10completionyys6ResultOyAA0F7URLInfoCAA0A8SDKErrorCGc_tF":{"name":"getPollingURL(completion:)","abstract":"

    Gets polling URL for checking new changes in an event stream. Works only for user events.

    ","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC013observeForNewC04with10completionyAA14PollingURLInfoC_ys6ResultOyAA0jL0CAA0A8SDKErrorCGctF":{"name":"observeForNewEvents(with:completion:)","abstract":"

    Makes long-polling request for new changes. Server does not return response immediatelly. It only returns response when either","parent_name":"EventsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC3get11devicePinId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(devicePinId:fields:completion:)","abstract":"

    Retrieves a specified Device Pin.

    ","parent_name":"DevicePinsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC17listForEnterprise12enterpriseId6marker5limit9direction6fieldsAA14PagingIteratorCyAA0C3PinCGSS_SSSgSiSgAA14OrderDirectionOSgSaySSGSgtF":{"name":"listForEnterprise(enterpriseId:marker:limit:direction:fields:)","abstract":"

    Retrieves all Device Pins for an enterprise.

    ","parent_name":"DevicePinsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC6delete11devicePinId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(devicePinId:completion:)","abstract":"

    Deletes the specified Device Pin.

    ","parent_name":"DevicePinsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC3get9commentId6fields10completionySS_SaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"get(commentId:fields:completion:)","abstract":"

    Get information about a comment.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6update9commentId7message6fields10completionySS_SSSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"update(commentId:message:fields:completion:)","abstract":"

    Updates the message for a comment.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6create6itemId0F4Type7message6fields10completionySS_S2SSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"create(itemId:itemType:message:fields:completion:)","abstract":"

    Creates a comment on an item.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6delete9commentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(commentId:completion:)","abstract":"

    Deletes the comment.

    ","parent_name":"CommentsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC4list6offset5limit6fieldsAA14PagingIteratorCyAA0A10CollectionCGSiSg_AMSaySSGSgtF":{"name":"list(offset:limit:fields:)","abstract":"

    Retrieves the collections for the given user.

    ","parent_name":"CollectionsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC12getFavorites6fields10completionySaySSGSg_ys6ResultOyAA0A10CollectionCAA0A8SDKErrorCGctF":{"name":"getFavorites(fields:completion:)","abstract":"

    Retrieve the favorites collection

    ","parent_name":"CollectionsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC9listItems12collectionId6offset5limit6fieldsAA14PagingIteratorCyAA10FolderItemOGSS_SiSgANSaySSGSgtF":{"name":"listItems(collectionId:offset:limit:fields:)","abstract":"

    Gets all of the files, folders, or web links contained within a collection.

    ","parent_name":"CollectionsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC3get15collaborationId6fields10completionySS_SaySSGSgys6ResultOyAA13CollaborationCAA0A8SDKErrorCGctF":{"name":"get(collaborationId:fields:completion:)","abstract":"

    Get information about a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6create8itemType0F2Id4role12accessibleBy0jkG011canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSAA010AccessibleK0OSbSgSaySSGSgARys6ResultOyAA0R0CAA0A8SDKErrorCGctF":{"name":"create(itemType:itemId:role:accessibleBy:accessibleByType:canViewPath:fields:notify:completion:)","abstract":"

    Create a new collaboration that grants a group access to a file or folder in a specific role.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC17createByUserEmail8itemType0I2Id4role5login11canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSSbSgSaySSGSgAOys6ResultOyAA0T0CAA0A8SDKErrorCGctF":{"name":"createByUserEmail(itemType:itemId:role:login:canViewPath:fields:notify:completion:)","abstract":"

    Create a new collaboration that grants a user to a file or folder in a specific role.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6update15collaborationId4role6status11canViewPath6fields10completionySS_AA17CollaborationRoleOAA0O6StatusOSgSbSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"update(collaborationId:role:status:canViewPath:fields:completion:)","abstract":"

    Update a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6delete15collaborationId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(collaborationId:completion:)","abstract":"

    Delete a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC24listPendingForEnterprise6offset5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSiSg_AMSaySSGSgtF":{"name":"listPendingForEnterprise(offset:limit:fields:)","abstract":"

    Get information about a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC31getAcceptanceRequirementsStatus15collaborationId10completionySS_ys6ResultOyAA13CollaborationC0fgH0CAA0A8SDKErrorCGctF":{"name":"getAcceptanceRequirementsStatus(collaborationId:completion:)","abstract":"

    Retrieves the acceptance requirements status for a specified collaboration

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC11listEntries6fields6marker5limitAA14PagingIteratorCyAA0cD5EntryCGSaySSGSg_SSSgSiSgtF":{"name":"listEntries(fields:marker:limit:)","abstract":"

    Returns the list of Allowlist entries for the current Enterprise. Each entry lists type, id,","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC3get2id6fields10completionySS_SaySSGSgys6ResultOyAA0cD5EntryCAA0A8SDKErrorCGctF":{"name":"get(id:fields:completion:)","abstract":"

    Get Collaboration Allowlist Entry by ID.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC6create6domain9direction6fields10completionySS_AA0C9DirectionOSaySSGSgys6ResultOyAA0cD5EntryCAA0A8SDKErrorCGctF":{"name":"create(domain:direction:fields:completion:)","abstract":"

    Create Collaboration Allowlist Entry.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC6delete2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(id:completion:)","abstract":"

    Remove a single item from the Enterprise’s Collaboration Allowlist by id.","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC17listExemptTargets6marker5limit6fieldsAA14PagingIteratorCyAA0cdG6TargetCGSSSg_SiSgSaySSGSgtF":{"name":"listExemptTargets(marker:limit:fields:)","abstract":"

    Returns an interator for listing of Exempt User entries for the current Enterprise.","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC15getExemptTarget2id6fields10completionySS_SaySSGSgys6ResultOyAA0cdgH0CAA0A8SDKErrorCGctF":{"name":"getExemptTarget(id:fields:completion:)","abstract":"

    Returns a specific exempt target for the passed in ID.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC10exemptUser6userId6fields10completionySS_SaySSGSgys6ResultOyAA0cD12ExemptTargetCAA0A8SDKErrorCGctF":{"name":"exemptUser(userId:fields:completion:)","abstract":"

    Creates the Exempt Target entry.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC18deleteExemptTarget2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteExemptTarget(id:completion:)","abstract":"

    Remove a single user from the exempt target list.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC7refresh0E5Token10completionySS_ys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"refresh(refreshToken:completion:)","abstract":"

    Refresh the given token.

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC8getToken8withCode10completionySS_ys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"getToken(withCode:completion:)","abstract":"

    Exchange an authorization code for an access token

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC11revokeToken5token10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"revokeToken(token:completion:)","abstract":"

    Revokes an access or refresh token, rendering it invalid.

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC14downscopeToken06parentF05scope8resource10sharedLink10completionySS_ShyAA0F5ScopeOGSSSgAMys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(parentToken:scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"AuthModule"},"Classes/FileLogDestination.html#/s:6BoxSDK18FileLogDestinationC7fileURLAC10Foundation0G0V_tcfc":{"name":"init(fileURL:)","abstract":"

    Intializer.

    ","parent_name":"FileLogDestination"},"Classes/FileLogDestination.html#/s:6BoxSDK18FileLogDestinationC5write_5level8category_ys12StaticStringV_AA0D5LevelOAA0D8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message into a file

    ","parent_name":"FileLogDestination"},"Classes/ConsoleLogDestination.html#/s:6BoxSDK21ConsoleLogDestinationC5write_5level8category_ys12StaticStringV_AA0D5LevelOAA0D8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message into the console

    ","parent_name":"ConsoleLogDestination"},"Classes/MetadataSearchFilter.html#/s:6BoxSDK20MetadataSearchFilterCACycfc":{"name":"init()","abstract":"

    Initializer

    ","parent_name":"MetadataSearchFilter"},"Classes/MetadataSearchFilter.html#/s:6BoxSDK20MetadataSearchFilterC03addE011templateKey05fieldH00I5Value5scope8relationySS_S2SAA0C5ScopeOAA0cE5BoundOtF":{"name":"addFilter(templateKey:fieldKey:fieldValue:scope:relation:)","abstract":"

    Adds a new filter object to our list of filter objects.

    ","parent_name":"MetadataSearchFilter"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC9errorTypeSSvp":{"name":"errorType","abstract":"

    Type of error

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC7messageAA0aC4EnumOvp":{"name":"message","abstract":"

    Error message

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC10stackTraceSaySSGvp":{"name":"stackTrace","abstract":"

    Stack trace

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC5errors5Error_pSgvp":{"name":"error","abstract":"

    Error

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC13getDictionarySDySSypGyF":{"name":"getDictionary()","abstract":"

    Get a dictionary representing BoxSDKError

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC11descriptionSSvp":{"name":"description","abstract":"

    Provides error JSON string if found.

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"BoxSDKError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC7requestAA0A18RequestDescriptionVSgvp":{"name":"request","abstract":"

    The components that make up a description of a BoxRequest

    ","parent_name":"BoxAPIError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC8responseAA0A19ResponseDescriptionVSgvp":{"name":"response","abstract":"

    The components that make up a description of a BoxResponse

    ","parent_name":"BoxAPIError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC13getDictionarySDySSypGyF":{"name":"getDictionary()","abstract":"

    Get a dictionary representing BoxAPIError

    ","parent_name":"BoxAPIError"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5filesAA11FilesModuleCvp":{"name":"files","abstract":"

    Provides File management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7foldersAA13FoldersModuleCvp":{"name":"folders","abstract":"

    Provides Folder management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5usersAA11UsersModuleCvp":{"name":"users","abstract":"

    Provides User management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6groupsAA12GroupsModuleCvp":{"name":"groups","abstract":"

    Provides Group management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8commentsAA14CommentsModuleCvp":{"name":"comments","abstract":"

    Provides Comment management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11sharedItemsAA06SharedE6ModuleCvp":{"name":"sharedItems","abstract":"

    Provides SharedItem management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8webLinksAA03WebE6ModuleCvp":{"name":"webLinks","abstract":"

    Web Links management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6searchAA12SearchModuleCvp":{"name":"search","abstract":"

    Provides search functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11collectionsAA17CollectionsModuleCvp":{"name":"collections","abstract":"

    Provides collections functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14collaborationsAA20CollaborationsModuleCvp":{"name":"collaborations","abstract":"

    Provides collaborations functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC22collaborationWhiteListAA28CollaborationAllowlistModuleCvp":{"name":"collaborationWhiteList","abstract":"

    Provides collaborations whitelist functionality (deprecated)

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC22collaborationAllowListAA28CollaborationAllowlistModuleCvp":{"name":"collaborationAllowList","abstract":"

    Provides collaborations whitelist functionality

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8metadataAA14MetadataModuleCvp":{"name":"metadata","abstract":"

    Metadata management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6eventsAA12EventsModuleCvp":{"name":"events","abstract":"

    Provides Events management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC21metadataCascadePolicyAA08MetadataeF6ModuleCvp":{"name":"metadataCascadePolicy","abstract":"

    Metadata cascade policy.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5trashAA11TrashModuleCvp":{"name":"trash","abstract":"

    Trash management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC10devicePinsAA06DeviceE6ModuleCvp":{"name":"devicePins","abstract":"

    Device Pin management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11recentItemsAA06RecentE6ModuleCvp":{"name":"recentItems","abstract":"

    Recent Items management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8webhooksAA14WebhooksModuleCvp":{"name":"webhooks","abstract":"

    Webhooks management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5tasksAA11TasksModuleCvp":{"name":"tasks","abstract":"

    Tasks management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC15retentionPolicyAA23RetentionPoliciesModuleCvp":{"name":"retentionPolicy","abstract":"

    Retention policy management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14termsOfServiceAA05TermsE14ServicesModuleCvp":{"name":"termsOfService","abstract":"

    Provides TermsOfService

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC10legalHoldsAA05LegalE6ModuleCvp":{"name":"legalHolds","abstract":"

    Legal Hold Policies management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC15storagePoliciesAA07StorageE6ModuleCvp":{"name":"storagePolicies","abstract":"

    Storage Policies management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7sessionAA15SessionProtocol_pvp":{"name":"session","abstract":"

    Provides authentication session management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7headersSDyS2SGSgvp":{"name":"headers","abstract":"

    Requests header.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC13configurationAA0A16SDKConfigurationVvp":{"name":"configuration","abstract":"

    SDK request configuration.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11isDestroyedSbvp":{"name":"isDestroyed","abstract":"

    Indicates whether this BoxClient instance has been destroyed

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC21favoritesCollectionIdSSSgvp":{"name":"favoritesCollectionId","abstract":"

    ID of user’s favorites collection.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC12networkAgent7session13configurationAcA07NetworkE8Protocol_p_AA07SessionI0_pAA0A16SDKConfigurationVtcfc":{"name":"init(networkAgent:session:configuration:)","abstract":"

    Initializer

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14withSharedLink3url8passwordAC10Foundation3URLV_SSSgtF":{"name":"withSharedLink(url:password:)","abstract":"

    Creates BoxClient instance based on shared link URL and password.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6asUser6withIdACSS_tF":{"name":"asUser(withId:)","abstract":"

    Creates BoxClient instance based on user identifier.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7destroy10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"destroy(completion:)","abstract":"

    Destroys the client, revoking its access tokens and rendering it inoperable.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC13exchangeToken5scope8resource10sharedLink10completionyShyAA0E5ScopeOG_SSSgALys6ResultOyAA0E4InfoCAA0A8SDKErrorCGctF":{"name":"exchangeToken(scope:resource:sharedLink:completion:)","abstract":"

    Exchange the token.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3get3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"get(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP GET method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC4post3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC4post3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters4data8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAM4DataVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:data:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response - variant for chunked upload.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7options3url11httpHeaders15queryParameters4json10completionAA0A11NetworkTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"options(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP OPTIONS method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6delete3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"delete(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP DELETE method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8download3url0D14DestinationURL11httpHeaders15queryParameters8progress10completionAA0A12DownloadTaskC10Foundation0G0V_AOSDyS2SGSDySSAA25QueryParameterConvertible_pSgGySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"download(url:downloadDestinationURL:httpHeaders:queryParameters:progress:completion:)","abstract":"

    Performs an HTTP GET method call for downloading on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxSDK/Constants.html#/s:6BoxSDKAAC9ConstantsO10rootFolderSSvpZ":{"name":"rootFolder","abstract":"

    Root folder identifier

    ","parent_name":"Constants"},"Classes/BoxSDK/Constants.html#/s:6BoxSDKAAC9ConstantsO11currentUserSSvpZ":{"name":"currentUser","abstract":"

    Current user identifier

    ","parent_name":"Constants"},"Classes/BoxSDK/Constants.html":{"name":"Constants","abstract":"

    Box-specific constants

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC13configurationAA0A16SDKConfigurationVvp":{"name":"configuration","abstract":"

    SDK configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC20defaultConfigurationAA0A16SDKConfigurationVvpZ":{"name":"defaultConfiguration","abstract":"

    Default configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC4authAA10AuthModuleCvp":{"name":"auth","abstract":"

    Auth module providing authorization and token related requests.","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC8clientId0C6Secret11callbackURLABSS_S2SSgtcfc":{"name":"init(clientId:clientSecret:callbackURL:)","abstract":"

    Initializer

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC9getClient5tokenAA0aD0CSS_tFZ":{"name":"getClient(token:)","abstract":"

    Creates BoxClient object based on developer token

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC9getClient5tokenAA0aD0CSS_tF":{"name":"getClient(token:)","abstract":"

    Creates BoxClient with developer token

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC22getDelegatedAuthClient11authClosure8uniqueID9tokenInfo0K5Store10completionyySS_ys6ResultOySS11accessToken_Sd9expiresInts5Error_pGctc_SSAA0qL0CSgAA0qM0_pSgyAJyAA0aF0CAA0A8SDKErrorCGctF":{"name":"getDelegatedAuthClient(authClosure:uniqueID:tokenInfo:tokenStore:completion:)","abstract":"

    Creates BoxClient using JWT token.

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC15getOAuth2Client9tokenInfo0F5Store7context10completionyAA05TokenG0CSg_AA0kH0_pSgSo47ASWebAuthenticationPresentationContextProviding_pys6ResultOyAA0aE0CAA0A8SDKErrorCGctF":{"name":"getOAuth2Client(tokenInfo:tokenStore:context:completion:)","abstract":"

    Creates BoxClient in a completion with OAuth 2.0 type of authentication

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC15getOAuth2Client9tokenInfo0F5Store10completionyAA05TokenG0CSg_AA0jH0_pSgys6ResultOyAA0aE0CAA0A8SDKErrorCGctF":{"name":"getOAuth2Client(tokenInfo:tokenStore:completion:)","abstract":"

    Creates BoxClient in a completion with OAuth 2.0 type of authentication

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC19updateConfiguration10apiBaseURL09uploadApifG016maxRetryAttempts21tokenRefreshThreshold21consoleLogDestination04fileqR019clientAnalyticsInfoy10Foundation0G0VSg_ANSiSgSdSgAA07ConsoleqR0CSgAA04FileqR0CSgAA06ClientuV0VSgtKF":{"name":"updateConfiguration(apiBaseURL:uploadApiBaseURL:maxRetryAttempts:tokenRefreshThreshold:consoleLogDestination:fileLogDestination:clientAnalyticsInfo:)","abstract":"

    Updates current SDK configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC16makeAuthorizeURL5state10Foundation0E0VSSSg_tF":{"name":"makeAuthorizeURL(state:)","abstract":"

    Creates OAuth2 authorization URL you can use in browser to authorize.

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html":{"name":"BoxSDK","abstract":"

    Provides methods for creating BoxSDKClient

    "},"Classes/BoxClient.html":{"name":"BoxClient","abstract":"

    Provides communication with Box APIs. Defines methods for communication with Box APIs

    "},"Classes.html#/s:6BoxSDK0A12APIAuthErrorC":{"name":"BoxAPIAuthError","abstract":"

    Describes authentication errors.

    "},"Classes/BoxAPIError.html":{"name":"BoxAPIError","abstract":"

    Describes API request related errors.

    "},"Classes.html#/s:6BoxSDK0A11CodingErrorC":{"name":"BoxCodingError","abstract":"

    Describes encoding and decoding related errors.

    "},"Classes.html#/s:6BoxSDK0A12NetworkErrorC":{"name":"BoxNetworkError","abstract":"

    Describes network related errors.

    "},"Classes/BoxSDKError.html":{"name":"BoxSDKError","abstract":"

    Describes general SDK errors

    "},"Classes/MetadataSearchFilter.html":{"name":"MetadataSearchFilter","abstract":"

    Provides functionality for creating a Metadata Search Filter.

    "},"Classes/ConsoleLogDestination.html":{"name":"ConsoleLogDestination","abstract":"

    Defines logging into a console

    "},"Classes/FileLogDestination.html":{"name":"FileLogDestination","abstract":"

    Defines logging into a file

    "},"Classes/AuthModule.html":{"name":"AuthModule","abstract":"

    Provides Token management.

    "},"Classes/CollaborationAllowlistModule.html":{"name":"CollaborationAllowlistModule","abstract":"

    Provides Collaborations management.

    "},"Classes/CollaborationsModule.html":{"name":"CollaborationsModule","abstract":"

    Provides Collaborations management.

    "},"Classes/CollectionsModule.html":{"name":"CollectionsModule","abstract":"

    Management of collections of files and folders. The only collection available is the “Favorites”.

    "},"Classes/CommentsModule.html":{"name":"CommentsModule","abstract":"

    Provides Comment management

    "},"Classes/DevicePinsModule.html":{"name":"DevicePinsModule","abstract":"

    Provides DevicePin management.

    "},"Classes/EventsModule.html":{"name":"EventsModule","abstract":"

    Provides Event management.

    "},"Classes/FilesModule.html":{"name":"FilesModule","abstract":"

    Provides File management.

    "},"Classes/FoldersModule.html":{"name":"FoldersModule","abstract":"

    Provides Folder management.

    "},"Classes/GroupsModule.html":{"name":"GroupsModule","abstract":"

    Provides Group management

    "},"Classes/LegalHoldsModule.html":{"name":"LegalHoldsModule","abstract":"

    Provides management of Legal Holds

    "},"Classes/MetadataCascadePolicyModule.html":{"name":"MetadataCascadePolicyModule","abstract":"

    Defines methods for metadata management

    "},"Classes/MetadataModule.html":{"name":"MetadataModule","abstract":"

    Defines methods for metadata management

    "},"Classes/RecentItemsModule.html":{"name":"RecentItemsModule","abstract":"

    Returns information about files that have been accessed by a user not long ago.

    "},"Classes/RetentionPoliciesModule.html":{"name":"RetentionPoliciesModule","abstract":"

    Provides RetentionPolicy management.

    "},"Classes/SearchModule.html":{"name":"SearchModule","abstract":"

    Provides functionality to search for content.

    "},"Classes/SharedItemsModule.html":{"name":"SharedItemsModule","abstract":"

    Provides SharedItem management.

    "},"Classes/StoragePoliciesModule.html":{"name":"StoragePoliciesModule","abstract":"

    Provides management of Storage Policies

    "},"Classes/TasksModule.html":{"name":"TasksModule","abstract":"

    Provides Tasks management

    "},"Classes/TermsOfServicesModule.html":{"name":"TermsOfServicesModule","abstract":"

    Provides TermsOfService management.

    "},"Classes/TrashModule.html":{"name":"TrashModule","abstract":"

    Module for trash management

    "},"Classes/UsersModule.html":{"name":"UsersModule","abstract":"

    Provides User management.

    "},"Classes/WebLinksModule.html":{"name":"WebLinksModule","abstract":"

    Provides Web Link management.

    "},"Classes/WebhooksModule.html":{"name":"WebhooksModule","abstract":"

    Provides management of Webhooks

    "},"Classes.html#/s:6BoxSDK0A12DownloadTaskC":{"name":"BoxDownloadTask","abstract":"

    A Box network task for a download

    "},"Classes/BoxNetworkAgent.html":{"name":"BoxNetworkAgent","abstract":"

    Implementation of networking layer

    "},"Classes/BoxNetworkTask.html":{"name":"BoxNetworkTask","abstract":"

    A Box network task request.

    "},"Classes.html#/s:6BoxSDK0A10UploadTaskC":{"name":"BoxUploadTask","abstract":"

    A Box network task returned for a upload

    "},"Classes/PagingIterator.html":{"name":"PagingIterator","abstract":"

    Provides paged iterator access for a collection of BoxModel’s

    "},"Classes/BoxRequest.html":{"name":"BoxRequest","abstract":"

    Represents Box SDK API request.

    "},"Classes/BoxCollection.html":{"name":"BoxCollection","abstract":"

    Collections contain information about the items contained inside of them, including files and folders."},"Classes/Classification.html":{"name":"Classification","abstract":"

    Details about the classification applied to a Box file or folder

    "},"Classes/Collaboration.html":{"name":"Collaboration","abstract":"

    Defines access permissions for users and groups to files and folders, similar to access control lists."},"Classes/CollaborationAllowlistEntry.html":{"name":"CollaborationAllowlistEntry","abstract":"

    An allowlisted domain in the enterprise. This record consists of both direction"},"Classes/CollaborationAllowlistExemptTarget.html":{"name":"CollaborationAllowlistExemptTarget","abstract":"

    The record that represents a target (at the moment, only users are supported as targets)"},"Classes/Collaborator.html":{"name":"Collaborator","abstract":"

    User taking part in a collaboration.

    "},"Classes/Comment.html":{"name":"Comment","abstract":"

    Message generated by Box users. Each message is tied to a specific file."},"Classes/DevicePin.html":{"name":"DevicePin","abstract":"

    Defines a device pin which allows the enterprise to control devices connecting to it.

    "},"Classes/EmailAlias.html":{"name":"EmailAlias","abstract":"

    User’s email alias.

    "},"Classes/Enterprise.html":{"name":"Enterprise","abstract":"

    Enterprise

    "},"Classes/EntryContainer.html":{"name":"EntryContainer","abstract":"

    Container for an entries (Box items)

    "},"Classes/Order.html":{"name":"Order","abstract":"

    Defines the order of items

    "},"Classes/EntryContainerInnerModel.html":{"name":"EntryContainerInnerModel","abstract":"

    Entry container for items of inner model

    "},"Classes/Event.html":{"name":"Event","abstract":"

    An event object associated with user or enterprise events.

    "},"Classes/EventContainer.html":{"name":"EventContainer","abstract":"

    Container for Events

    "},"Classes/EventItem.html":{"name":"EventItem","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/ExpiringEmbedLink.html":{"name":"ExpiringEmbedLink","abstract":"

    Expiring embed link of a file

    "},"Classes/File.html":{"name":"File","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/FileVersion.html":{"name":"FileVersion","abstract":"

    Specific version of a file.

    "},"Classes/FileVersionLegalHold.html":{"name":"FileVersionLegalHold","abstract":"

    A file version legal hold object represents all holds on a file version

    "},"Classes/FileVersionRetention.html":{"name":"FileVersionRetention","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/Folder.html":{"name":"Folder","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/FolderLock.html":{"name":"FolderLock","abstract":"

    Folder Lock

    "},"Classes/FolderUploadEmail.html":{"name":"FolderUploadEmail","abstract":"

    Defines upload email address for a folder.

    "},"Classes/Group.html":{"name":"Group","abstract":"

    Contain a set of users, and can be used in place of users in some operations, such as collaborations.

    "},"Classes/GroupMembership.html":{"name":"GroupMembership","abstract":"

    Membership of a group

    "},"Classes/Invite.html":{"name":"Invite","abstract":"

    Defines invitation for a user to join enterprise

    "},"Classes/LegalHoldPolicy.html":{"name":"LegalHoldPolicy","abstract":"

    Legal hold policy

    "},"Classes/LegalHoldPolicyAssignment.html":{"name":"LegalHoldPolicyAssignment","abstract":"

    Legal hold policy assignment

    "},"Classes/LegalHoldPolicyAssignmentItem.html":{"name":"LegalHoldPolicyAssignmentItem","abstract":"

    Legal hold policy assignment item

    "},"Classes/Lock.html":{"name":"Lock","abstract":"

    Locks a file to prevent it from being modified

    "},"Classes/MetadataCascadePolicy.html":{"name":"MetadataCascadePolicy","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/MetadataObject.html":{"name":"MetadataObject","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/MetadataTemplate.html":{"name":"MetadataTemplate","abstract":"

    Metadata that belongs to a file or folder is grouped by templates."},"Classes/PathCollection.html":{"name":"PathCollection","abstract":"

    The path of folders to an item, starting at the root.

    "},"Classes/PollingResult.html":{"name":"PollingResult","abstract":"

    An events long polling result.

    "},"Classes/PollingURLInfo.html":{"name":"PollingURLInfo","abstract":"

    Polling URL info for requesting changes in event stream.

    "},"Classes/RecentItem.html":{"name":"RecentItem","abstract":"

    Item recently iteracted with

    "},"Classes/RetentionPolicy.html":{"name":"RetentionPolicy","abstract":"

    A retention policy blocks permanent deletion of content for a specified amount of time.

    "},"Classes/RetentionPolicyAssignment.html":{"name":"RetentionPolicyAssignment","abstract":"

    The retention policy assignment provides a way for admins to apply a retention policy on a per-folder basis,"},"Classes/RetentionPolicyAssignmentItem.html":{"name":"RetentionPolicyAssignmentItem","abstract":"

    The type and id of the content that is under retention.

    "},"Classes/RetentionPolicyEntry.html":{"name":"RetentionPolicyEntry","abstract":"

    Retention policy entry

    "},"Classes/Scope.html":{"name":"Scope","abstract":"

    Permission scope for a token.

    "},"Classes/SearchResult.html":{"name":"SearchResult","abstract":"

    Files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user.

    "},"Classes/SharedItem.html":{"name":"SharedItem","abstract":"

    Item shared by shared link.

    "},"Classes/SharedLink.html":{"name":"SharedLink","abstract":"

    Provides direct, read-only access to files or folder on Box using a URL

    "},"Classes/StoragePolicy.html":{"name":"StoragePolicy","abstract":"

    Storage policy

    "},"Classes/StoragePolicyAssignment.html":{"name":"StoragePolicyAssignment","abstract":"

    Storage policy assignment

    "},"Classes/Task.html":{"name":"Task","abstract":"

    Enables file-centric workflows in Box. User can create tasks on files and assign them to collaborators on Box."},"Classes/TaskAssignment.html":{"name":"TaskAssignment","abstract":"

    Task assignment to a single user. There can be multiple assignments on a given task.

    "},"Classes/TermsOfService.html":{"name":"TermsOfService","abstract":"

    The Terms of Service allows Box Admins to configure a custom ToS indicating to users."},"Classes/TermsOfServiceUserStatus.html":{"name":"TermsOfServiceUserStatus","abstract":"

    Represents a Terms of Service status for a given user.

    "},"Classes/Token.html":{"name":"Token","abstract":"

    Embed link token

    "},"Classes/TokenInfo.html":{"name":"TokenInfo","abstract":"

    Info about the tokens used by the SDK for authentication.

    "},"Classes/TrackingCode.html":{"name":"TrackingCode","abstract":"

    Admin-defined information about a user

    "},"Classes/UploadPart.html":{"name":"UploadPart","abstract":"

    Object representing part of chunked upload.

    "},"Classes/UploadSession.html":{"name":"UploadSession","abstract":"

    Session object for chunked upload.

    "},"Classes/User.html":{"name":"User","abstract":"

    User of the Box application.

    "},"Classes/Watermark.html":{"name":"Watermark","abstract":"

    Watermark object labels folders and files to be protected by watermarks, which will show on file previews."},"Classes/WebLink.html":{"name":"WebLink","abstract":"

    Object that points to URLs. These objects are also known as bookmarks within the Box web application.

    "},"Classes/Webhook.html":{"name":"Webhook","abstract":"

    Defines a Webhook, which enables event triggers to be attached to Box files and folders

    "},"Classes/ZipDownload.html":{"name":"ZipDownload","abstract":"

    Defines a Zip Download

    "},"Classes/ZipDownloadConflict.html":{"name":"ZipDownloadConflict","abstract":"

    Defines a Zip Download Conflict

    "},"Classes/ZipDownloadConflictItem.html":{"name":"ZipDownloadConflictItem","abstract":"

    Defines a Zip Download Conflict Item

    "},"Classes/ZipDownloadStatus.html":{"name":"ZipDownloadStatus","abstract":"

    Status of a Zip download

    "},"Classes/DelegatedAuthSession.html":{"name":"DelegatedAuthSession","abstract":"

    An authorization session using JWT token

    "},"Classes/OAuth2Session.html":{"name":"OAuth2Session","abstract":"

    OAuth 2 Session

    "},"Classes/SingleTokenSession.html":{"name":"SingleTokenSession","abstract":"

    Developer session that only requires a developer token. Session will only work as long as the token is valid.

    "},"Classes/KeychainTokenStore.html":{"name":"KeychainTokenStore","abstract":"

    Token store that uses the Apple keychain

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file +{"Typealiases.html#/s:6BoxSDK8Callbacka":{"name":"Callback","abstract":"

    Closure to return any generic type or an BoxSDKError"},"Typealiases.html#/s:6BoxSDK16TokenInfoClosurea":{"name":"TokenInfoClosure","abstract":"

    Closure returning either standard TokenInfo object or error."},"Typealiases.html#/s:6BoxSDK15QueryParametersa":{"name":"QueryParameters","abstract":"

    Represents API request query parameters.

    "},"Typealiases.html#/s:6BoxSDK0A11HTTPHeadersa":{"name":"BoxHTTPHeaders","abstract":"

    Represents HTTP headers for API requests.

    "},"Typealiases.html#/s:6BoxSDK16AccessTokenTuplea":{"name":"AccessTokenTuple","abstract":"

    Contains access token and its expiration date.

    "},"Typealiases.html#/s:6BoxSDK20DelegatedAuthClosurea":{"name":"DelegatedAuthClosure","abstract":"

    Contains unique ID as an identifier for JWT token provider and completion returning either valid access token information or an error.

    "},"Typealiases.html#/s:6BoxSDK18AccessTokenClosurea":{"name":"AccessTokenClosure","abstract":"

    Closure returning either access token string or error."},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV2idSSvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"ZipDownloadItem"},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV4typeSSvp":{"name":"type","abstract":"

    Box item type - should be file or folder.

    ","parent_name":"ZipDownloadItem"},"Structs/ZipDownloadItem.html#/s:6BoxSDK15ZipDownloadItemV2id4typeACSS_SStcfc":{"name":"init(id:type:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadItem"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV6partIdSSvp":{"name":"partId","abstract":"

    Part Id

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV6offsetSivp":{"name":"offset","abstract":"

    Part offset

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4sizeSivp":{"name":"size","abstract":"

    Part size

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4sha1SSSgvp":{"name":"sha1","abstract":"

    Part SHA hash

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    The upload part description’s raw data

    ","parent_name":"UploadPartDescription"},"Structs/UploadPartDescription.html#/s:6BoxSDK21UploadPartDescriptionV18jsonRepresentationSDySSypGyF":{"name":"jsonRepresentation()","abstract":"

    Get the upload part description in JSON

    ","parent_name":"UploadPartDescription"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5fieldSSvp":{"name":"field","abstract":"

    The field to match against.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5valueSSvp":{"name":"value","abstract":"

    The value to match against.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataFieldFilter.html#/s:6BoxSDK19MetadataFieldFilterV5field5valueACSS_SStcfc":{"name":"init(field:value:)","abstract":"

    Initializer.

    ","parent_name":"MetadataFieldFilter"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV2idSSSgvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV4typeSSSgvp":{"name":"type","abstract":"

    The data type of the field’s value.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV3keySSSgvp":{"name":"key","abstract":"

    A unique identifier for the field. The identifier must be unique within the template to which it belongs.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV11displayNameSSSgvp":{"name":"displayName","abstract":"

    The display name of the field.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the field.

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV7optionsSaySDyS2SGGSgvp":{"name":"options","abstract":"

    For type enum, a list of all possible value

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV6hiddenSbSgvp":{"name":"hidden","abstract":"

    Whether this template is hidden in the UI

    ","parent_name":"MetadataField"},"Structs/MetadataField.html#/s:6BoxSDK13MetadataFieldV2id4type3key11displayName11description7options6hiddenACSSSg_A4KSaySDyS2SGGSgSbSgtcfc":{"name":"init(id:type:key:displayName:description:options:hidden:)","abstract":"

    Initializer.

    ","parent_name":"MetadataField"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO4noneyA2EmF":{"name":"none","abstract":"

    Generating the representation needs to be manually triggered (see info.url note).

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO7pendingyA2EmF":{"name":"pending","abstract":"

    Content is being generated but is not ready yet.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO8viewableyA2EmF":{"name":"viewable","abstract":"

    Similar to pending, though indicates that enough content is available to be useful.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO7successyA2EmF":{"name":"success","abstract":"

    All of the content is available and complete.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO5erroryA2EmF":{"name":"error","abstract":"

    An error happened and this content is not available.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK18FileRepresentationV10StatusEnumO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    A custom value not implemented in this version of SDK.

    ","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"StatusEnum"},"Structs/FileRepresentation/StatusEnum.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"StatusEnum"},"Structs/FileRepresentation/Status.html#/s:6BoxSDK18FileRepresentationV6StatusV5stateAC0E4EnumOSgvp":{"name":"state","abstract":"

    State describing the status

    ","parent_name":"Status"},"Structs/FileRepresentation/Info.html#/s:6BoxSDK18FileRepresentationV4InfoV3urlSSSgvp":{"name":"url","abstract":"

    An opaque URL which will return status information about the file.

    ","parent_name":"Info"},"Structs/FileRepresentation/Content.html#/s:6BoxSDK18FileRepresentationV7ContentV11urlTemplateSSSgvp":{"name":"urlTemplate","abstract":"

    An opaque URL template to the content.

    ","parent_name":"Content"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV7contentAC7ContentVSgvp":{"name":"content","abstract":"

    An opaque URL template to the content.

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV4infoAC4InfoVSgvp":{"name":"info","abstract":"

    An opaque URL which will return status information about the file.

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV10propertiesSDyS2SGvp":{"name":"properties","abstract":"

    A set of static properties to distinguish between subtypes of a given representation,","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV6statusAC6StatusVSgvp":{"name":"status","abstract":"

    Status string

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation.html#/s:6BoxSDK18FileRepresentationV14representationSSSgvp":{"name":"representation","abstract":"

    Usually the extension of the format, but occasionally a name of a standard (potentially de facto)","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Content.html":{"name":"Content","abstract":"

    Contains an opaque URL template to the content, which follows RFC 6570.","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Info.html":{"name":"Info","abstract":"

    Contains an opaque URL which will return status information about the file.","parent_name":"FileRepresentation"},"Structs/FileRepresentation/Status.html":{"name":"Status","abstract":"

    Defines the current status of the file representation generation

    ","parent_name":"FileRepresentation"},"Structs/FileRepresentation/StatusEnum.html":{"name":"StatusEnum","abstract":"

    A string with one of the following values: ‘none’, ‘pending’, ‘viewable’, ‘error’ and ‘success’.

    ","parent_name":"FileRepresentation"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV10statusCodeSiSgvp":{"name":"statusCode","abstract":"

    The HTTP status code of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV7headersSDyS2SGSgvp":{"name":"headers","abstract":"

    The HTTP headers of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxResponseDescription.html#/s:6BoxSDK0A19ResponseDescriptionV4bodySDySSypGSgvp":{"name":"body","abstract":"

    The body component of the response

    ","parent_name":"BoxResponseDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV6methodSSvp":{"name":"method","abstract":"

    The HTTP method for the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV3urlAA0A13URLComponentsVvp":{"name":"url","abstract":"

    The URL the BoxRequest is sent to

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV7headersSDyS2SGvp":{"name":"headers","abstract":"

    The HTTP headers sent in the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxRequestDescription.html#/s:6BoxSDK0A18RequestDescriptionV4bodySSSgvp":{"name":"body","abstract":"

    The optional body of the BoxRequest

    ","parent_name":"BoxRequestDescription"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV6schemeSSSgvp":{"name":"scheme","abstract":"

    URL scheme information

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV4hostSSSgvp":{"name":"host","abstract":"

    URL host information

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV4pathSSSgvp":{"name":"path","abstract":"

    URL path

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV5querySDyS2SGSgvp":{"name":"query","abstract":"

    Optional URL query parameters

    ","parent_name":"BoxURLComponents"},"Structs/BoxURLComponents.html#/s:6BoxSDK0A13URLComponentsV8fragmentSSSgvp":{"name":"fragment","abstract":"

    Optional page reference / anchor

    ","parent_name":"BoxURLComponents"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV27isDocumentPreparationNeededSbSgvp":{"name":"isDocumentPreparationNeeded","abstract":"

    Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV24areTextSignaturesEnabledSbSgvp":{"name":"areTextSignaturesEnabled","abstract":"

    Disables the usage of signatures generated by typing (text). Default is true.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV12emailSubjectSSSgvp":{"name":"emailSubject","abstract":"

    Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV12emailMessageSSSgvp":{"name":"emailMessage","abstract":"

    Message to include in sign request email. The field is cleaned through sanitization of specific characters.","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV19areRemindersEnabledSbSgvp":{"name":"areRemindersEnabled","abstract":"

    Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV11prefillTagsSayAA0cD10PrefillTagCGSgvp":{"name":"prefillTags","abstract":"

    List of prefill tags.","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV9daysValidSiSgvp":{"name":"daysValid","abstract":"

    Number of days after which this request will automatically expire if not completed.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV10externalIdSSSgvp":{"name":"externalId","abstract":"

    This can be used to reference an ID in an external system that the sign request is related to.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateParameters.html#/s:6BoxSDK27SignRequestCreateParametersV27isDocumentPreparationNeeded24areTextSignaturesEnabled12emailSubject0O7Message0k9RemindersN011prefillTags9daysValid10externalIdACSbSg_ALSSSgAmLSayAA0cD10PrefillTagCGSgSiSgAMtcfc":{"name":"init(isDocumentPreparationNeeded:areTextSignaturesEnabled:emailSubject:emailMessage:areRemindersEnabled:prefillTags:daysValid:externalId:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateParameters"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV5emailSSvp":{"name":"email","abstract":"

    Email address of the signer

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV4roleAA0cdF4RoleOSgvp":{"name":"role","abstract":"

    Role of the signer

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV10isInPersonSbSgvp":{"name":"isInPerson","abstract":"

    Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV5orderSiSgvp":{"name":"order","abstract":"

    Order of the signer.

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV22embedUrlExternalUserIdSSSgvp":{"name":"embedUrlExternalUserId","abstract":"

    User ID for the signer in an external application responsible for authentication when accessing the embed URL.

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateSigner.html#/s:6BoxSDK23SignRequestCreateSignerV5email4role10isInPerson5order22embedUrlExternalUserIdACSS_AA0cdF4RoleOSgSbSgSiSgSSSgtcfc":{"name":"init(email:role:isInPerson:order:embedUrlExternalUserId:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateSigner"},"Structs/SignRequestCreateParentFolder.html#/s:6BoxSDK29SignRequestCreateParentFolderV2idSSvp":{"name":"id","abstract":"

    Identifier of the folder

    ","parent_name":"SignRequestCreateParentFolder"},"Structs/SignRequestCreateParentFolder.html#/s:6BoxSDK29SignRequestCreateParentFolderV2idACSS_tcfc":{"name":"init(id:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateParentFolder"},"Structs/SignRequestCreateParentFolder.html#/s:6BoxSDK29SignRequestCreateParentFolderV6folderAcA0G0C_tcfc":{"name":"init(folder:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateParentFolder"},"Structs/SignRequestCreateSourceFile.html#/s:6BoxSDK27SignRequestCreateSourceFileV2idSSvp":{"name":"id","abstract":"

    Identifier of the file

    ","parent_name":"SignRequestCreateSourceFile"},"Structs/SignRequestCreateSourceFile.html#/s:6BoxSDK27SignRequestCreateSourceFileV11fileVersionAA0cdefgI0VSgvp":{"name":"fileVersion","abstract":"

    The version information of the file.

    ","parent_name":"SignRequestCreateSourceFile"},"Structs/SignRequestCreateSourceFile.html#/s:6BoxSDK27SignRequestCreateSourceFileV2id13fileVersionIdACSS_SSSgtcfc":{"name":"init(id:fileVersionId:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateSourceFile"},"Structs/SignRequestCreateSourceFile.html#/s:6BoxSDK27SignRequestCreateSourceFileV4fileAcA0G0C_tcfc":{"name":"init(file:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateSourceFile"},"Structs/SignRequestCreateSourceFileVersion.html#/s:6BoxSDK34SignRequestCreateSourceFileVersionV2idSSvp":{"name":"id","abstract":"

    The ID of the file version object

    ","parent_name":"SignRequestCreateSourceFileVersion"},"Structs/SignRequestCreateSourceFileVersion.html#/s:6BoxSDK34SignRequestCreateSourceFileVersionV2idACSS_tcfc":{"name":"init(id:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestCreateSourceFileVersion"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV6accessAA0cD6AccessOSgvp":{"name":"access","abstract":"

    The access level for the shared link. Can be open (“People with the link”),","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV8passwordAA17NullableParameterOySSGSgvp":{"name":"password","abstract":"

    The password required to access the shared link.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV10unsharedAtAA17NullableParameterOy10Foundation4DateVGSgvp":{"name":"unsharedAt","abstract":"

    The date-time that this link will become disabled.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV11permissionsSDySSSbGSgvp":{"name":"permissions","abstract":"

    Whether the shared link allows downloads and previews.

    ","parent_name":"SharedLinkData"},"Structs/SharedLinkData.html#/s:6BoxSDK14SharedLinkDataV6access8password10unsharedAt11canDownloadAcA0cD6AccessOSg_AA17NullableParameterOySSGSgALy10Foundation4DateVGSgSbSgtcfc":{"name":"init(access:password:unsharedAt:canDownload:)","abstract":"

    Initializer.

    ","parent_name":"SharedLinkData"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormVACycfc":{"name":"init()","abstract":"

    Initialize an empty form.

    ","parent_name":"MultipartForm"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormV10appendPart4name8contentsySS_10Foundation4DataVtF":{"name":"appendPart(name:contents:)","abstract":"

    Append a body part to the form.

    ","parent_name":"MultipartForm"},"Structs/MultipartForm.html#/s:6BoxSDK13MultipartFormV14appendFilePart4name8contents6length8fileName8mimeTypeySS_So13NSInputStreamCSiS2StF":{"name":"appendFilePart(name:contents:length:fileName:mimeType:)","abstract":"

    Append a file body part to the form.

    ","parent_name":"MultipartForm"},"Structs/LockData.html#/s:6BoxSDK8LockDataV9expiresAt19isDownloadPreventedAC10Foundation4DateVSg_SbSgtcfc":{"name":"init(expiresAt:isDownloadPrevented:)","abstract":"

    Initializer.

    ","parent_name":"LockData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV13canRunReportsSbSgvp":{"name":"canRunReports","abstract":"

    Whether the user can run reports.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV15canInstantLoginSbSgvp":{"name":"canInstantLogin","abstract":"

    Whether the user can instant login.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV17canCreateAccountsSbSgvp":{"name":"canCreateAccounts","abstract":"

    Whether the user can create other accounts.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV15canEditAccountsSbSgvp":{"name":"canEditAccounts","abstract":"

    Whether the user can edit accounts.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ConfigurablePermissionData.html#/s:6BoxSDK26ConfigurablePermissionDataV13canRunReports0F12InstantLogin0F14CreateAccounts0f4EditL0ACSbSg_A3Htcfc":{"name":"init(canRunReports:canInstantLogin:canCreateAccounts:canEditAccounts:)","abstract":"

    Initializer.

    ","parent_name":"ConfigurablePermissionData"},"Structs/ClientAnalyticsInfo.html#/s:6BoxSDK19ClientAnalyticsInfoV7appName0F7VersionACSS_SStcfc":{"name":"init(appName:appVersion:)","abstract":"

    Initializer

    ","parent_name":"ClientAnalyticsInfo"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV8clientIdSSvp":{"name":"clientId","abstract":"

    The client ID of the application requesting authentication. To get the client ID for your application,","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV12clientSecretSSvp":{"name":"clientSecret","abstract":"

    The client secret of the application requesting authentication. To get the client secret for your application,","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV10apiBaseURL10Foundation0F0Vvp":{"name":"apiBaseURL","abstract":"

    Base URL for majority of the requests.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV16uploadApiBaseURL10Foundation0G0Vvp":{"name":"uploadApiBaseURL","abstract":"

    Base URL for file upload requests.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV18oauth2AuthorizeURL10Foundation0F0Vvp":{"name":"oauth2AuthorizeURL","abstract":"

    URL for the OAuth2 authorization page, where users are redirected to enter their credentials

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV16maxRetryAttemptsSivp":{"name":"maxRetryAttempts","abstract":"

    Maximum number of retries for a failed request.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV21tokenRefreshThresholdSdvp":{"name":"tokenRefreshThreshold","abstract":"

    Specifies how long before token expiration date it should be refreshed.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV17retryBaseIntervalSdvp":{"name":"retryBaseInterval","abstract":"

    The base factor used in calculating exponential backoff delay for retries

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV19clientAnalyticsInfoAA06ClienteF0VSgvp":{"name":"clientAnalyticsInfo","abstract":"

    Analytics info that is set to request headers.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV21consoleLogDestinationAA07ConsoleeF0Cvp":{"name":"consoleLogDestination","abstract":"

    Console log destination.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV18fileLogDestinationAA04FileeF0CSgvp":{"name":"fileLogDestination","abstract":"

    File log destination.

    ","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html#/s:6BoxSDK0A16SDKConfigurationV11callbackURLSSvp":{"name":"callbackURL","abstract":"

    An optional custom callback URL string. The URL to which Box redirects the browser when authentication completes.","parent_name":"BoxSDKConfiguration"},"Structs/BoxSDKConfiguration.html":{"name":"BoxSDKConfiguration","abstract":"

    SDK configuration specifying request related information

    "},"Structs/ClientAnalyticsInfo.html":{"name":"ClientAnalyticsInfo","abstract":"

    Analytics info about the app using the SDK.

    "},"Structs/ConfigurablePermissionData.html":{"name":"ConfigurablePermissionData","abstract":"

    Defines configurable permission data for creating and updating group membership."},"Structs/LockData.html":{"name":"LockData","abstract":"

    Defines a lock on a Box item

    "},"Structs/MultipartForm.html":{"name":"MultipartForm","abstract":"

    Representation of a multipart form request body.

    "},"Structs/SharedLinkData.html":{"name":"SharedLinkData","abstract":"

    Defines shared link data for updating file information."},"Structs/SignRequestCreateSourceFileVersion.html":{"name":"SignRequestCreateSourceFileVersion","abstract":"

    Represents a file version of a file included in a sign request

    "},"Structs/SignRequestCreateSourceFile.html":{"name":"SignRequestCreateSourceFile","abstract":"

    Represents a file to be included in a sign request.

    "},"Structs/SignRequestCreateParentFolder.html":{"name":"SignRequestCreateParentFolder","abstract":"

    Represents a destination folder to place final, signed document and signing log.

    "},"Structs/SignRequestCreateSigner.html":{"name":"SignRequestCreateSigner","abstract":"

    Defines a signer for Create Sign Request",

    "},"Structs/SignRequestCreateParameters.html":{"name":"SignRequestCreateParameters","abstract":"

    Defines a request to creatre a sign request object.

    "},"Structs/BoxURLComponents.html":{"name":"BoxURLComponents","abstract":"

    The components that make up a URL

    "},"Structs/BoxRequestDescription.html":{"name":"BoxRequestDescription","abstract":"

    The components that make up a description of a BoxRequest

    "},"Structs.html#/s:6BoxSDK0A8ResponseV":{"name":"BoxResponse","abstract":"

    Box API request response

    "},"Structs/BoxResponseDescription.html":{"name":"BoxResponseDescription","abstract":"

    The components that make up a description of a BoxResponse

    "},"Structs/FileRepresentation.html":{"name":"FileRepresentation","abstract":"

    Digital assets created for files stored in Box.

    "},"Structs/MetadataField.html":{"name":"MetadataField","abstract":"

    A field in a metadata template.

    "},"Structs/MetadataFieldFilter.html":{"name":"MetadataFieldFilter","abstract":"

    Filter for matching against a metadata field

    "},"Structs/UploadPartDescription.html":{"name":"UploadPartDescription","abstract":"

    Description of uploaded part

    "},"Structs/ZipDownloadItem.html":{"name":"ZipDownloadItem","abstract":"

    Item field for creating a Zip download.

    "},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP4read10completionyys6ResultOyAA0C4InfoCs5Error_pGc_tF":{"name":"read(completion:)","abstract":"

    Retrieves current token information

    ","parent_name":"TokenStore"},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP5write9tokenInfo10completionyAA0cG0C_ys6ResultOyyts5Error_pGctF":{"name":"write(tokenInfo:completion:)","abstract":"

    Sets new token data

    ","parent_name":"TokenStore"},"Protocols/TokenStore.html#/s:6BoxSDK10TokenStoreP5clear10completionyys6ResultOyyts5Error_pGc_tF":{"name":"clear(completion:)","abstract":"

    Removes a token

    ","parent_name":"TokenStore"},"Protocols/ExpiredTokenHandling.html#/s:6BoxSDK20ExpiredTokenHandlingP06handlecD010completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"handleExpiredToken(completion:)","abstract":"

    Handles token expiration.

    ","parent_name":"ExpiredTokenHandling"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","abstract":"

    Gets access token

    ","parent_name":"SessionProtocol"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","abstract":"

    Revokes all the tokens

    ","parent_name":"SessionProtocol"},"Protocols/SessionProtocol.html#/s:6BoxSDK15SessionProtocolP14downscopeToken5scope8resource10sharedLink10completionyShyAA0F5ScopeOG_SSSgALys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"SessionProtocol"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    Raw data from the API that populates the model

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonx10Foundation4DataV_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelP4jsonSSyF":{"name":"json()","abstract":"

    Gets JSON string for a Box model object.

    ","parent_name":"BoxModel"},"Protocols/BoxModel.html#/s:6BoxSDK0A5ModelPAAE12toJSONStringSSyF":{"name":"toJSONString()","abstract":"

    Gets JSON string for a Box model object.

    ","parent_name":"BoxModel"},"Protocols/QueryParameterConvertible.html#/s:6BoxSDK25QueryParameterConvertibleP15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"QueryParameterConvertible"},"Protocols/NetworkAgentProtocol.html#/s:6BoxSDK20NetworkAgentProtocolP4send7request10completionyAA0A7RequestC_ys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"send(request:completion:)","abstract":"

    Makes a Box SDK request

    ","parent_name":"NetworkAgentProtocol"},"Protocols/TokenRefreshing.html#/s:6BoxSDK15TokenRefreshingP7refresh0eC010completionySS_ys6ResultOyAA0C4InfoCAA0A8SDKErrorCGctF":{"name":"refresh(refreshToken:completion:)","abstract":"

    Refreshes a token.

    ","parent_name":"TokenRefreshing"},"Protocols/TokenRefreshing.html#/s:6BoxSDK15TokenRefreshingP03getC08withCode10completionySS_ys6ResultOyAA0C4InfoCAA0A8SDKErrorCGctF":{"name":"getToken(withCode:completion:)","abstract":"

    Exchange an authorization code for an access token

    ","parent_name":"TokenRefreshing"},"Protocols/LogDestination.html#/s:6BoxSDK14LogDestinationP5write_5level8category_ys12StaticStringV_AA0C5LevelOAA0C8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message

    ","parent_name":"LogDestination"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE2eeoiySbx_SStFZ":{"name":"==(_:_:)","abstract":"

    Compare equality between enum and string

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE2eeoiySbSS_xtFZ":{"name":"==(_:_:)","abstract":"

    Compare equality between string and enum

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

    Encode the enum to a JSON string

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"BoxEnum"},"Protocols/BoxEnum.html#/s:6BoxSDK0A4EnumPAAE4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

    Initialization using decoder

    ","parent_name":"BoxEnum"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3get3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"get(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP GET method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP4post3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP4post3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP3put3url11httpHeaders15queryParameters4data8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAM4DataVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:data:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response - variant for chunked upload.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP7options3url11httpHeaders15queryParameters4json10completionAA0A11NetworkTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"options(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP OPTIONS method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html#/s:6BoxSDK0A14ClientProtocolP6delete3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"delete(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP DELETE method call on an API endpoint and returns a response.

    ","parent_name":"BoxClientProtocol"},"Protocols/BoxClientProtocol.html":{"name":"BoxClientProtocol","abstract":"

    Defines methods for communication with Box APIs

    "},"Protocols/BoxEnum.html":{"name":"BoxEnum","abstract":"

    General BoxEnum protocol specifying response model enum behaviour

    "},"Protocols/LogDestination.html":{"name":"LogDestination","abstract":"

    Defines main log destination behaviour

    "},"Protocols/TokenRefreshing.html":{"name":"TokenRefreshing","abstract":"

    Defines methods for Token refreshing.

    "},"Protocols/NetworkAgentProtocol.html":{"name":"NetworkAgentProtocol","abstract":"

    Defines networking layer interface

    "},"Protocols/QueryParameterConvertible.html":{"name":"QueryParameterConvertible","abstract":"

    Defines items convertible to query parameter

    "},"Protocols/BoxModel.html":{"name":"BoxModel","abstract":"

    Defines Box SDK model behavior

    "},"Protocols.html#/s:6BoxSDK0A10InnerModelP":{"name":"BoxInnerModel","abstract":"

    Box inner model

    "},"Protocols/SessionProtocol.html":{"name":"SessionProtocol","abstract":"

    Defines methods for managing session token.

    "},"Protocols/ExpiredTokenHandling.html":{"name":"ExpiredTokenHandling","abstract":"

    Defines handler for expired token.

    "},"Protocols/TokenStore.html":{"name":"TokenStore","abstract":"

    Defines an interface for managing token.

    "},"Extensions/Optional.html#/s:Sq6BoxSDKAA25QueryParameterConvertibleRzlE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Optional"},"Extensions/Array.html#/s:Sa6BoxSDKSyRzlE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Array"},"Extensions/NSString.html#/s:So8NSStringC6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"NSString"},"Extensions/NSNumber.html#/s:So8NSNumberC6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"NSNumber"},"Extensions/Bool.html#/s:Sb6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Bool"},"Extensions/Int.html#/s:Si6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"Int"},"Extensions/String.html#/s:SS6BoxSDKE15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"String"},"Extensions/String.html":{"name":"String"},"Extensions/Int.html":{"name":"Int"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/NSNumber.html":{"name":"NSNumber"},"Extensions/NSString.html":{"name":"NSString"},"Extensions/Array.html":{"name":"Array"},"Extensions/Optional.html":{"name":"Optional"},"Enums/WebhookItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO6folderyAcA6FolderCcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:6BoxSDK11WebhookItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"WebhookItem"},"Enums/WebhookItem.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"WebhookItem"},"Enums/TaskItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:6BoxSDK8TaskItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File with task assignment.

    ","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:6BoxSDK8TaskItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TaskItem"},"Enums/TaskItem.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"TaskItem"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO9completedyA2CmF":{"name":"completed","abstract":"

    Completed

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO10incompleteyA2CmF":{"name":"incomplete","abstract":"

    Incomplete

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO8approvedyA2CmF":{"name":"approved","abstract":"

    Approved

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Rejected

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK15AssignmentStateO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not implemented in this version of SDK.

    ","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"AssignmentState"},"Enums/AssignmentState.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AssignmentState"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO9completedyA2CmF":{"name":"completed","abstract":"

    Completed

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO10incompleteyA2CmF":{"name":"incomplete","abstract":"

    Incomplete

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO8approvedyA2CmF":{"name":"approved","abstract":"

    Approved

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Rejected

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK16AssignmentStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not implemented in this version of SDK.

    ","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"AssignmentStatus"},"Enums/AssignmentStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AssignmentStatus"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO6reviewyA2CmF":{"name":"review","abstract":"

    Approval task that can be approved or rejected

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO8completeyA2CmF":{"name":"complete","abstract":"

    General task which can be completed

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom task action

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"TaskAction"},"Enums/TaskAction.html#/s:6BoxSDK10TaskActionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"TaskAction"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO12allAssigneesyA2CmF":{"name":"allAssignees","abstract":"

    Task is complete when all assignees complete it

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11anyAssigneeyA2CmF":{"name":"anyAssignee","abstract":"

    Task is complete when any assignees complete it

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"TaskCompletionRule"},"Enums/TaskCompletionRule.html#/s:6BoxSDK18TaskCompletionRuleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"TaskCompletionRule"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO9signatureyA2CmF":{"name":"signature","abstract":"

    Signature input.

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO4dateyA2CmF":{"name":"date","abstract":"

    Date input.

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO4textyA2CmF":{"name":"text","abstract":"

    Text input.

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO8checkboxyA2CmF":{"name":"checkbox","abstract":"

    Checkbox input.

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK26SignRequestSignerInputTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerInputType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SignRequestSignerInputType"},"Enums/SignRequestSignerDecisionType.html#/s:6BoxSDK29SignRequestSignerDecisionTypeO6signedyA2CmF":{"name":"signed","abstract":"

    Signed decision.

    ","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerDecisionType.html#/s:6BoxSDK29SignRequestSignerDecisionTypeO8declinedyA2CmF":{"name":"declined","abstract":"

    Declined decision.

    ","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerDecisionType.html#/s:6BoxSDK29SignRequestSignerDecisionTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom value not implemented in this version of SDK.

    ","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerDecisionType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerDecisionType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SignRequestSignerDecisionType"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK21SignRequestSignerRoleO6signeryA2CmF":{"name":"signer","abstract":"

    Role needed to sign the document.

    ","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK21SignRequestSignerRoleO8approveryA2CmF":{"name":"approver","abstract":"

    Role needed to approve the document.

    ","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK21SignRequestSignerRoleO15finalCopyReaderyA2CmF":{"name":"finalCopyReader","abstract":"

    Role which receives the final signded document and signing log.

    ","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK21SignRequestSignerRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SignRequestSignerRole"},"Enums/SignRequestSignerRole.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SignRequestSignerRole"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO10convertingyA2CmF":{"name":"converting","abstract":"

    Converting status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO7createdyA2CmF":{"name":"created","abstract":"

    Created status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO4sentyA2CmF":{"name":"sent","abstract":"

    Sent status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO6viewedyA2CmF":{"name":"viewed","abstract":"

    Viewed status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO6signedyA2CmF":{"name":"signed","abstract":"

    Signed status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO9cancelledyA2CmF":{"name":"cancelled","abstract":"

    Cancelled status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO8declinedyA2CmF":{"name":"declined","abstract":"

    Declined status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO15errorConvertingyA2CmF":{"name":"errorConverting","abstract":"

    Error converting status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO12errorSendingyA2CmF":{"name":"errorSending","abstract":"

    Error sending status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO7expiredyA2CmF":{"name":"expired","abstract":"

    Expired status.

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK17SignRequestStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SignRequestStatus"},"Enums/SignRequestStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SignRequestStatus"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO4openyA2CmF":{"name":"open","abstract":"

    Anyone with the link can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO7companyyA2CmF":{"name":"company","abstract":"

    People in your company can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO13collaboratorsyA2CmF":{"name":"collaborators","abstract":"

    People in this folder can access.

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK16SharedLinkAccessO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented by the SDK

    ","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"SharedLinkAccess"},"Enums/SharedLinkAccess.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SharedLinkAccess"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO14annotationEdityA2CmF":{"name":"annotationEdit","abstract":"

    Allow user to edit annotations (delete).

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO17annotationViewAllyA2CmF":{"name":"annotationViewAll","abstract":"

    Allows user to view all users’ annotations.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO18annotationViewSelfyA2CmF":{"name":"annotationViewSelf","abstract":"

    Allows user to view their own annotations only.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO12baseExploreryA2CmF":{"name":"baseExplorer","abstract":"

    Allows access to content in the folder tree based on user/file/token permissions.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10basePickeryA2CmF":{"name":"basePicker","abstract":"

    Allows access to content in the folder tree based on user/file/token permissions.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11basePreviewyA2CmF":{"name":"basePreview","abstract":"

    Allows the user to preview the file, nothing else.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11baseSidebaryA2CmF":{"name":"baseSidebar","abstract":"

    Allows the user to get basic file info needed for the sidebar.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10baseUploadyA2CmF":{"name":"baseUpload","abstract":"

    Allows upload into the folder specific under “resource” of the Token Exchange request.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemDeleteyA2CmF":{"name":"itemDelete","abstract":"

    Allows file/folders to be deleted.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO12itemDownloadyA2CmF":{"name":"itemDownload","abstract":"

    Allows files/folders contents to be downloaded.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11itemPreviewyA2CmF":{"name":"itemPreview","abstract":"

    Automatically enables preview of the file, upon user click (requires Preview UI Element to be referenced).

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemRenameyA2CmF":{"name":"itemRename","abstract":"

    Allows files/folders to be renamed.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO9itemShareyA2CmF":{"name":"itemShare","abstract":"

    Allows sharing of resource specified under “resource” of the Token Exchange request.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO10itemUploadyA2CmF":{"name":"itemUpload","abstract":"

    Allows upload in the content picker.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom permission that was not yet implemented in this version of SDK.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TokenScope"},"Enums/TokenScope.html#/s:6BoxSDK10TokenScopeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of token scope

    ","parent_name":"TokenScope"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO6folderyA2CmF":{"name":"folder","abstract":"

    Folder type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    Enterprise type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO16metadataTemplateyA2CmF":{"name":"metadataTemplate","abstract":"

    Metadata template type of content with retention policy assignment.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK33RetentionPolicyAssignmentItemTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this version of SDK.

    ","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyAssignmentItemType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyAssignmentItemType"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO6activeyA2CmF":{"name":"active","abstract":"

    Retention policy is active.

    ","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO7retiredyA2CmF":{"name":"retired","abstract":"

    Retention policy is retired. Can be only retired by administrator","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK21RetentionPolicyStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value that was not yet implemented in current SDK version.

    ","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyStatus"},"Enums/RetentionPolicyStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyStatus"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO17permanentlyDeleteyA2CmF":{"name":"permanentlyDelete","abstract":"

    Content retained by the policy to be permanently deleted once the retention policy time period has passed.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO15removeRetentionyA2CmF":{"name":"removeRetention","abstract":"

    Will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy time period has passed.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK17DispositionActionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in the SDK.

    ","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"DispositionAction"},"Enums/DispositionAction.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"DispositionAction"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO6finiteyA2CmF":{"name":"finite","abstract":"

    A specific amount of time to retain the content is known upfront.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO10indefiniteyA2CmF":{"name":"indefinite","abstract":"

    The amount of time to retain the content is still unknown.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK19RetentionPolicyTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this SDK version.

    ","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"RetentionPolicyType"},"Enums/RetentionPolicyType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RetentionPolicyType"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO13addEnumOptionyACSS_SDySSypGtcACmF":{"name":"addEnumOption(fieldKey:data:)","abstract":"

    Adds an enum option at the end of the enum option list for the specified field.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO8addFieldyACSDySSypG_tcACmF":{"name":"addField(data:)","abstract":"

    Adds a field at the end of the field list for the template.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO04editD0yACSDySSypG_tcACmF":{"name":"editTemplate(data:)","abstract":"

    Edits any number of the base properties of a template: displayName, hidden.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO18reorderEnumOptionsyACSS_SaySSGtcACmF":{"name":"reorderEnumOptions(fieldKey:enumOptionKeys:)","abstract":"

    Reorders the enum option list to match the requested enum option list.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO13reorderFieldsyACSaySSG_tcACmF":{"name":"reorderFields(fieldKeys:)","abstract":"

    Reorders the field list to match the requested field list

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO9editFieldyACSS_SDySSypGtcACmF":{"name":"editField(fieldKey:data:)","abstract":"

    Edits any number of the base properties of a field: displayName, hidden, description, key.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO14editEnumOptionyACSS_SDySSypGSStcACmF":{"name":"editEnumOption(fieldKey:data:enumOptionKey:)","abstract":"

    Edits the enumOption.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO16removeEnumOptionyACSS_SStcACmF":{"name":"removeEnumOption(fieldKey:enumOptionKey:)","abstract":"

    Removes the specified enum option from the specified enum field.

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO11removeFieldyACSS_tcACmF":{"name":"removeField(fieldKey:)","abstract":"

    Removes the specified field from the template

    ","parent_name":"MetadataTemplateOperation"},"Enums/MetadataTemplateOperation.html#/s:6BoxSDK25MetadataTemplateOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an option.

    ","parent_name":"MetadataTemplateOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO3addyACSS_SStcACmF":{"name":"add(path:value:)","abstract":"

    Adds new metadata path/value pair

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO7replaceyACSS_SStcACmF":{"name":"replace(path:value:)","abstract":"

    Replaces metadata for path with a new value

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO4testyACSS_SStcACmF":{"name":"test(path:value:)","abstract":"

    Tests expected metadata value for given path

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO6removeyACSS_tcACmF":{"name":"remove(path:)","abstract":"

    Removes metadata for given path

    ","parent_name":"FolderMetadataOperation"},"Enums/FolderMetadataOperation.html#/s:6BoxSDK23FolderMetadataOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an operation option.

    ","parent_name":"FolderMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO3addyACSS_SStcACmF":{"name":"add(path:value:)","abstract":"

    Adds new metadata path/value pair

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO7replaceyACSS_SStcACmF":{"name":"replace(path:value:)","abstract":"

    Replaces metadata for path with a new value

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4testyACSS_SStcACmF":{"name":"test(path:value:)","abstract":"

    Tests expected metadata value for given path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO6removeyACSS_tcACmF":{"name":"remove(path:)","abstract":"

    Removes metadata for given path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4moveyACSS_SStcACmF":{"name":"move(from:path:)","abstract":"

    Moves metadata from original path to new path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4copyyACSS_SStcACmF":{"name":"copy(from:path:)","abstract":"

    Copies metadata from original path to new path

    ","parent_name":"FileMetadataOperation"},"Enums/FileMetadataOperation.html#/s:6BoxSDK21FileMetadataOperationO4jsonSDySSypGyF":{"name":"json()","abstract":"

    Creates JSON dictionary representation of an operation option.

    ","parent_name":"FileMetadataOperation"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO6memberyA2CmF":{"name":"member","abstract":"

    Default permission for a user in a Group.

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO5adminyA2CmF":{"name":"admin","abstract":"

    The admin of the Group.

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access that is not yet implemented

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"GroupRole"},"Enums/GroupRole.html#/s:6BoxSDK9GroupRoleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"GroupRole"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO10adminsOnlyyA2CmF":{"name":"adminsOnly","abstract":"

    Main Admin, Coadmins and group’s Group Admin can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO16adminsAndMembersyA2CmF":{"name":"adminsAndMembers","abstract":"

    Admins and group members can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO15allManagedUsersyA2CmF":{"name":"allManagedUsers","abstract":"

    All managed users in the enterprise can view the members of the group.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom level that was not yet implemented in this version of SDK.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelO11descriptionSSvp":{"name":"description","abstract":"

    String representation of member viewability level

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupMemberViewabilityLevel.html#/s:6BoxSDK27GroupMemberViewabilityLevelOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"GroupMemberViewabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO10adminsOnlyyA2CmF":{"name":"adminsOnly","abstract":"

    Main Admin, Co-admins, the group’s Group Admin can invite

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO16adminsAndMembersyA2CmF":{"name":"adminsAndMembers","abstract":"

    Admins and group members can invite

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO15allManagedUsersyA2CmF":{"name":"allManagedUsers","abstract":"

    All managed users in the enterprise.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom level that was not yet implemented in this version of SDK.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelO11descriptionSSvp":{"name":"description","abstract":"

    String representation of invitability level.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/GroupInvitabilityLevel.html#/s:6BoxSDK22GroupInvitabilityLevelOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"GroupInvitabilityLevel"},"Enums/FolderItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO6folderyAcA0C0CcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO7webLinkyAcA03WebF0CcACmF":{"name":"webLink(_:)","abstract":"

    Weblink type pointing to either a file or folder.

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FolderItem"},"Enums/FolderItem.html#/s:6BoxSDK10FolderItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Item debug description.

    ","parent_name":"FolderItem"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO11descriptionSSvp":{"name":"description","abstract":"

    String representation of sync state.

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO6syncedyA2CmF":{"name":"synced","abstract":"

    Folder will be synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO9notSyncedyA2CmF":{"name":"notSynced","abstract":"

    Folder will not be synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO15partiallySyncedyA2CmF":{"name":"partiallySynced","abstract":"

    Folder is partially synced by the Box sync clients

    ","parent_name":"SyncState"},"Enums/SyncState.html#/s:6BoxSDK9SyncStateO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom sync option, that is not yet implemented in this SDK version.

    ","parent_name":"SyncState"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO3pdfyA2CmF":{"name":"pdf","abstract":"

    The PDF representation

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO9thumbnailyA2CmF":{"name":"thumbnail","abstract":"

    Thumbnail image with resolution 320x320px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO11imageMediumyA2CmF":{"name":"imageMedium","abstract":"

    Image with resolution 1024x1024px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO10imageLargeyA2CmF":{"name":"imageLarge","abstract":"

    Image with resolution 2048x2048px.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO13extractedTextyA2CmF":{"name":"extractedText","abstract":"

    Extracted text from original document.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK22FileRepresentationHintO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    It is possible to use a custom value. See representations documentation.

    ","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"FileRepresentationHint"},"Enums/FileRepresentationHint.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"FileRepresentationHint"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemCreatedyA2CmF":{"name":"itemCreated","abstract":"

    A folder or file was created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12itemUploadedyA2CmF":{"name":"itemUploaded","abstract":"

    A folder or file was uploaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14commentCreatedyA2CmF":{"name":"commentCreated","abstract":"

    A comment was created on a folder, file, or other comment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14commentDeletedyA2CmF":{"name":"commentDeleted","abstract":"

    A comment was deleted on folder, file, or other comment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14itemDownloadedyA2CmF":{"name":"itemDownloaded","abstract":"

    A file or folder was downloaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13itemPreviewedyA2CmF":{"name":"itemPreviewed","abstract":"

    A file was previewed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9itemMovedyA2CmF":{"name":"itemMoved","abstract":"

    A file or folder was moved.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemCopiedyA2CmF":{"name":"itemCopied","abstract":"

    A file or folder was copied.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12taskAssignedyA2CmF":{"name":"taskAssigned","abstract":"

    A task was assigned.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11taskCreatedyA2CmF":{"name":"taskCreated","abstract":"

    A task was created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10fileLockedyA2CmF":{"name":"fileLocked","abstract":"

    A file was locked.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12fileUnlockedyA2CmF":{"name":"fileUnlocked","abstract":"

    A file was unlocked. If a locked file is deleted, the source file will be null.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemDeletedyA2CmF":{"name":"itemDeleted","abstract":"

    A file or folder was marked as deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13itemRecoveredyA2CmF":{"name":"itemRecovered","abstract":"

    A file or folder was recovered out of the trash.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17collaboratorAddedyA2CmF":{"name":"collaboratorAdded","abstract":"

    A collaborator was added to a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23collaboratorRoleChangedyA2CmF":{"name":"collaboratorRoleChanged","abstract":"

    A collaborator had their role changed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19collaboratorInvitedyA2CmF":{"name":"collaboratorInvited","abstract":"

    A collaborator was invited on a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19collaboratorRemovedyA2CmF":{"name":"collaboratorRemoved","abstract":"

    A collaborator was removed from a folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8itemSyncyA2CmF":{"name":"itemSync","abstract":"

    A folder was marked for sync.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemUnsyncyA2CmF":{"name":"itemUnsync","abstract":"

    A folder was un-marked for sync.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11itemRenamedyA2CmF":{"name":"itemRenamed","abstract":"

    A file or folder was renamed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21itemEnabledForSharingyA2CmF":{"name":"itemEnabledForSharing","abstract":"

    A file or folder was enabled for sharing.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22itemDisabledForSharingyA2CmF":{"name":"itemDisabledForSharing","abstract":"

    A file or folder was disabled for sharing.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemSharedyA2CmF":{"name":"itemShared","abstract":"

    A folder was shared.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22itemMadeCurrentVersionyA2CmF":{"name":"itemMadeCurrentVersion","abstract":"

    A previous version of a file was promoted to the current version.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8tagAddedyA2CmF":{"name":"tagAdded","abstract":"

    A Tag was added to a file or folder.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16twoFactorEnabledyA2CmF":{"name":"twoFactorEnabled","abstract":"

    2 factor authentication enabled by user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19adminInviteAcceptedyA2CmF":{"name":"adminInviteAccepted","abstract":"

    Free user accepts invitation to become a managed user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19adminInviteRejectedyA2CmF":{"name":"adminInviteRejected","abstract":"

    Free user rejects invitation to become a managed user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13accessGrantedyA2CmF":{"name":"accessGranted","abstract":"

    Granted Box access to account.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO13accessRevokedyA2CmF":{"name":"accessRevoked","abstract":"

    Revoke Box access to account.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16addedUserToGroupyA2CmF":{"name":"addedUserToGroup","abstract":"

    Added user to group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20removedUserFromGroupyA2CmF":{"name":"removedUserFromGroup","abstract":"

    Removed user from group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11createdUseryA2CmF":{"name":"createdUser","abstract":"

    Created user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12createdGroupyA2CmF":{"name":"createdGroup","abstract":"

    Created new group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12deletedGroupyA2CmF":{"name":"deletedGroup","abstract":"

    Deleted group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11deletedUseryA2CmF":{"name":"deletedUser","abstract":"

    Deleted user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11editedGroupyA2CmF":{"name":"editedGroup","abstract":"

    Edited group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10editedUseryA2CmF":{"name":"editedUser","abstract":"

    Edited user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10adminLoginyA2CmF":{"name":"adminLogin","abstract":"

    Admin login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21addedDeviceAssocationyA2CmF":{"name":"addedDeviceAssocation","abstract":"

    Added device association

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22changeFolderPermissionyA2CmF":{"name":"changeFolderPermission","abstract":"

    Edit the permissions on a folder

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11failedLoginyA2CmF":{"name":"failedLogin","abstract":"

    Failed login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO5loginyA2CmF":{"name":"login","abstract":"

    Login

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24removedDeviceAssociationyA2CmF":{"name":"removedDeviceAssociation","abstract":"

    Removed device association

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22deviceTrustCheckFailedyA2CmF":{"name":"deviceTrustCheckFailed","abstract":"

    Device Trust check failed

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22termsOfServiceAcceptedyA2CmF":{"name":"termsOfServiceAccepted","abstract":"

    Accepted terms

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22termsOfServiceRejectedyA2CmF":{"name":"termsOfServiceRejected","abstract":"

    Rejected terms

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19fileMarkedMaliciousyA2CmF":{"name":"fileMarkedMalicious","abstract":"

    Virus found on a file. Event is only received by enterprises that have opted in to be notified.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6copiedyA2CmF":{"name":"copied","abstract":"

    Copied

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO7deletedyA2CmF":{"name":"deleted","abstract":"

    Deleted

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10downloadedyA2CmF":{"name":"downloaded","abstract":"

    Downloaded

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6editedyA2CmF":{"name":"edited","abstract":"

    Edited

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO6lockedyA2CmF":{"name":"locked","abstract":"

    Locked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO5movedyA2CmF":{"name":"moved","abstract":"

    Moved

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9previewedyA2CmF":{"name":"previewed","abstract":"

    Previewed

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO7renamedyA2CmF":{"name":"renamed","abstract":"

    A file or folder name or description is changed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17storageExpirationyA2CmF":{"name":"storageExpiration","abstract":"

    Set file auto-delete

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO9undeletedyA2CmF":{"name":"undeleted","abstract":"

    Undeleted

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8unlockedyA2CmF":{"name":"unlocked","abstract":"

    Unlocked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8uploadedyA2CmF":{"name":"uploaded","abstract":"

    Uploaded

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12shareEnabledyA2CmF":{"name":"shareEnabled","abstract":"

    Enabled shared links

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16itemShareUpdatedyA2CmF":{"name":"itemShareUpdated","abstract":"

    Share links settings updated

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22shareExpirationUpdatedyA2CmF":{"name":"shareExpirationUpdated","abstract":"

    Extend shared link expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15shareExpirationyA2CmF":{"name":"shareExpiration","abstract":"

    Set shared link expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO8unsharedyA2CmF":{"name":"unshared","abstract":"

    Unshared shared link

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21collaborationAcceptedyA2CmF":{"name":"collaborationAccepted","abstract":"

    Accepted invites

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24collaborationRoleChangedyA2CmF":{"name":"collaborationRoleChanged","abstract":"

    Changed user roles

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO31collaborationExpirationExtendedyA2CmF":{"name":"collaborationExpirationExtended","abstract":"

    Extend collaborator expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20collaborationRemovedyA2CmF":{"name":"collaborationRemoved","abstract":"

    Removed collaborators

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22invitedToCollaborationyA2CmF":{"name":"invitedToCollaboration","abstract":"

    Invited

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23collaborationExpirationyA2CmF":{"name":"collaborationExpiration","abstract":"

    Set collaborator expiration

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24loginActivityDeviceAddedyA2CmF":{"name":"loginActivityDeviceAdded","abstract":"

    A user is logging in from a device we haven’t seen before.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26loginActivityDeviceRemovedyA2CmF":{"name":"loginActivityDeviceRemoved","abstract":"

    We invalidated a user session associated with an app.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO28userOAuth2AccessTokenCreatedyA2CmF":{"name":"userOAuth2AccessTokenCreated","abstract":"

    An OAuth 2.0 access token has been created

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20userAdminRoleChangedyA2CmF":{"name":"userAdminRoleChanged","abstract":"

    When an admin role changes for a user

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO35contentWorkflowUploadPolicyViolatedyA2CmF":{"name":"contentWorkflowUploadPolicyViolated","abstract":"

    A collaborator violated an admin-set upload policy

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15contentAccessedyA2CmF":{"name":"contentAccessed","abstract":"

    A content was accessed by a user.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataInstanceCreatedyA2CmF":{"name":"metadataInstanceCreated","abstract":"

    Creation of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23matadataInstanceUpdatedyA2CmF":{"name":"matadataInstanceUpdated","abstract":"

    Update of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23matadataInstanceDeletedyA2CmF":{"name":"matadataInstanceDeleted","abstract":"

    Deletion of metadata instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21taskAssignmentUpdatedyA2CmF":{"name":"taskAssignmentUpdated","abstract":"

    Update of a task assignment.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21taskAssignmentDeletedyA2CmF":{"name":"taskAssignmentDeleted","abstract":"

    A task assignment is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11taskUpdatedyA2CmF":{"name":"taskUpdated","abstract":"

    A task’s comment was edited.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16itemAddedToGroupyA2CmF":{"name":"itemAddedToGroup","abstract":"

    An item is added to a group.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20dataRetentionRemovedyA2CmF":{"name":"dataRetentionRemoved","abstract":"

    Retention is removed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO20dataRetentionCreatedyA2CmF":{"name":"dataRetentionCreated","abstract":"

    Retention is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO34dataRetentionPolicyAssignmentAddedyA2CmF":{"name":"dataRetentionPolicyAssignmentAdded","abstract":"

    A retention policy assignment is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26legalHoldAssignmentCreatedyA2CmF":{"name":"legalHoldAssignmentCreated","abstract":"

    A legal hold assignment is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO26legalHoldAssignmentDeletedyA2CmF":{"name":"legalHoldAssignmentDeleted","abstract":"

    A legal hold assignment is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyCreatedyA2CmF":{"name":"legalHoldPolicyCreated","abstract":"

    A legal hold policy is created.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyUpdatedyA2CmF":{"name":"legalHoldPolicyUpdated","abstract":"

    A legal hold policy is updated.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22legalHoldPolicyDeletedyA2CmF":{"name":"legalHoldPolicyDeleted","abstract":"

    A legal hold policy is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO22sharingPolicyViolationyA2CmF":{"name":"sharingPolicyViolation","abstract":"

    There is a sharing policy violation.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO25applicationPublicKeyAddedyA2CmF":{"name":"applicationPublicKeyAdded","abstract":"

    An application public key is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO27applicationPublicKeyDeletedyA2CmF":{"name":"applicationPublicKeyDeleted","abstract":"

    An application public key is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO18applicationCreatedyA2CmF":{"name":"applicationCreated","abstract":"

    A new application was created in the Box developer console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO18contentPolicyAddedyA2CmF":{"name":"contentPolicyAdded","abstract":"

    A content policy is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO15automationAddedyA2CmF":{"name":"automationAdded","abstract":"

    An automation is added.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO17automationDeletedyA2CmF":{"name":"automationDeleted","abstract":"

    An automation is deleted.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23userEmailAliasConfirmedyA2CmF":{"name":"userEmailAliasConfirmed","abstract":"

    A user email alias is confirmed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21userEmailAliasRemovedyA2CmF":{"name":"userEmailAliasRemoved","abstract":"

    A user email alias is removed.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO14watermarkAddedyA2CmF":{"name":"watermarkAdded","abstract":"

    A watermark is added to a file.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO16watermarkRemovedyA2CmF":{"name":"watermarkRemoved","abstract":"

    A watermark is removed from a file.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateCreatedyA2CmF":{"name":"metadataTemplateCreated","abstract":"

    Creation of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateUpdatedyA2CmF":{"name":"metadataTemplateUpdated","abstract":"

    Update of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO23metadataTemplateDeletedyA2CmF":{"name":"metadataTemplateDeleted","abstract":"

    Deletion of metadata template instance.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO10itemOpenedyA2CmF":{"name":"itemOpened","abstract":"

    Item was opened.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO12itemModifiedyA2CmF":{"name":"itemModified","abstract":"

    Item was modified.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO24abnormalDownloadActivityyA2CmF":{"name":"abnormalDownloadActivity","abstract":"

    When a policy set in the Admin console is triggered.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO21itemsRemovedFromGroupyA2CmF":{"name":"itemsRemovedFromGroup","abstract":"

    Folders were removed from a group in the Admin console.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO25watermarkedFileDownloadedyA2CmF":{"name":"watermarkedFileDownloaded","abstract":"

    A watermarked file was downloaded.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO33enterpriseAppAuthorizationUpdatedyA2CmF":{"name":"enterpriseAppAuthorizationUpdated","abstract":"

    When a JWT application has been authorized or reauthorized

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO27shieldJustificationApprovedyA2CmF":{"name":"shieldJustificationApproved","abstract":"

    A Shield justification is approved

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11shieldAlertyA2CmF":{"name":"shieldAlert","abstract":"

    Shield detected an anomalous download, session, location, or malicious content based on enterprise Shield rules

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19shieldAccessBlockedyA2CmF":{"name":"shieldAccessBlocked","abstract":"

    Access to an external collaboration is blocked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO33shieldBlockedMissingJustificationyA2CmF":{"name":"shieldBlockedMissingJustification","abstract":"

    Access to an external collaboration is blocked due to missing a justification

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO19shieldInviteBlockedyA2CmF":{"name":"shieldInviteBlocked","abstract":"

    An invite to externally collaborate is blocked

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO39shieldInviteBlockedMissingJustificationyA2CmF":{"name":"shieldInviteBlockedMissingJustification","abstract":"

    An invite to externally collaborate is blocked due to missing a justification

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom event type, that is not yet implemented in this SDK version.

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"EventType"},"Enums/EventType.html#/s:6BoxSDK9EventTypeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of sync state.

    ","parent_name":"EventType"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO9ascendingyA2CmF":{"name":"ascending","abstract":"

    Items sorted in ascending order.

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO10descendingyA2CmF":{"name":"descending","abstract":"

    Items sorted in descending order.

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK14OrderDirectionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom

    ","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"OrderDirection"},"Enums/OrderDirection.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"OrderDirection"},"Enums/CommentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO7commentyAcA0C0CcACmF":{"name":"comment(_:)","abstract":"

    Comment type

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CommentItem"},"Enums/CommentItem.html#/s:6BoxSDK11CommentItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Debug description of an object

    ","parent_name":"CommentItem"},"Enums/CollaborationItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO6folderyAcA6FolderCcACmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO4fileyAcA4FileCcACmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationItem"},"Enums/CollaborationItem.html#/s:6BoxSDK17CollaborationItemO16debugDescriptionSSvp":{"name":"debugDescription","abstract":"

    Debug description of an object

    ","parent_name":"CollaborationItem"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO7inboundyA2CmF":{"name":"inbound","abstract":"

    Inbound collaboration direction

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO8outboundyA2CmF":{"name":"outbound","abstract":"

    Outbound collaboration direction

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO4bothyA2CmF":{"name":"both","abstract":"

    Bi-directional collaboration

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK22CollaborationDirectionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom scope for metadata template.

    ","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"CollaborationDirection"},"Enums/CollaborationDirection.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"CollaborationDirection"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO6editoryA2CmF":{"name":"editor","abstract":"

    Editor role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO6vieweryA2CmF":{"name":"viewer","abstract":"

    Viewer role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO9previeweryA2CmF":{"name":"previewer","abstract":"

    Previewer rle

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO8uploaderyA2CmF":{"name":"uploader","abstract":"

    Uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO17previewerUploaderyA2CmF":{"name":"previewerUploader","abstract":"

    Preview uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO14viewerUploaderyA2CmF":{"name":"viewerUploader","abstract":"

    Viewer uploader role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO7coOwneryA2CmF":{"name":"coOwner","abstract":"

    Co-owner role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO5owneryA2CmF":{"name":"owner","abstract":"

    Owner role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value of a role that was not yet implemented in this versison of SDK.

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationRole"},"Enums/CollaborationRole.html#/s:6BoxSDK17CollaborationRoleO11descriptionSSvp":{"name":"description","abstract":"

    String representation of role

    ","parent_name":"CollaborationRole"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO8acceptedyA2CmF":{"name":"accepted","abstract":"

    Collaboration invitation accepted

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO7pendingyA2CmF":{"name":"pending","abstract":"

    Collaboration invitation is pending

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO8rejectedyA2CmF":{"name":"rejected","abstract":"

    Collaboration invitation was rejected

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Collaboration invitation status of custom value that was not yet implemented in this version of SDK.

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationStatus"},"Enums/CollaborationStatus.html#/s:6BoxSDK19CollaborationStatusO11descriptionSSvp":{"name":"description","abstract":"

    String representation of collaboration status.

    ","parent_name":"CollaborationStatus"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterO5valueyACyxGxcAEmlF":{"name":"value(_:)","abstract":"

    Specifies value that should be set to a parameter

    ","parent_name":"NullableParameter"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterO4nullyACyxGAEmlF":{"name":"null","abstract":"

    Empty value representing null

    ","parent_name":"NullableParameter"},"Enums/NullableParameter.html#/s:6BoxSDK17NullableParameterOAASERzlE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

    Encode the nullable parameter to either null or its encoded value

    ","parent_name":"NullableParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO6offsetyACSicACmF":{"name":"offset(_:)","abstract":"

    Offset

    ","parent_name":"PagingParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO6markeryACSSSgcACmF":{"name":"marker(_:)","abstract":"

    Marker

    ","parent_name":"PagingParameter"},"Enums/PagingParameter.html#/s:6BoxSDK15PagingParameterO14streamPositionyACSSSgcACmF":{"name":"streamPosition(_:)","abstract":"

    Stream position

    ","parent_name":"PagingParameter"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO7coadminyA2CmF":{"name":"coadmin","abstract":"

    Coadmin role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO5adminyA2CmF":{"name":"admin","abstract":"

    Admin role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO4useryA2CmF":{"name":"user","abstract":"

    User role

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom role that is not yet implemented

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"UserRole"},"Enums/UserRole.html#/s:6BoxSDK8UserRoleO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of user’s role.

    ","parent_name":"UserRole"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO6activeyA2CmF":{"name":"active","abstract":"

    User is active

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO8inactiveyA2CmF":{"name":"inactive","abstract":"

    User is inactive

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO18cannotDeleteOrEdityA2CmF":{"name":"cannotDeleteOrEdit","abstract":"

    User cannot delete or edit content

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO24cannotDeleteEditOrUploadyA2CmF":{"name":"cannotDeleteEditOrUpload","abstract":"

    User cannot delete, edit or upload content

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom user status that is not yet implemented

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"UserStatus"},"Enums/UserStatus.html#/s:6BoxSDK10UserStatusO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of user status.

    ","parent_name":"UserStatus"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO7managedyA2CmF":{"name":"managed","abstract":"

    The ToS is allowed to be accepted/rejected by managed users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO8externalyA2CmF":{"name":"external","abstract":"

    The ToS is allowed to be accepted/rejected by external users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceType.html#/s:6BoxSDK18TermsOfServiceTypeO11descriptionSSvp":{"name":"description","abstract":"

    String representation of scope of the ToS to the end users.

    ","parent_name":"TermsOfServiceType"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO7enabledyA2CmF":{"name":"enabled","abstract":"

    The ToS is currently enabled and active.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO8disabledyA2CmF":{"name":"disabled","abstract":"

    The ToS is currently disabled and inactive.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceStatus"},"Enums/TermsOfServiceStatus.html#/s:6BoxSDK20TermsOfServiceStatusO11descriptionSSvp":{"name":"description","abstract":"

    String representation of active/inactive indicator for ToS.

    ","parent_name":"TermsOfServiceStatus"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO4fileyA2CmF":{"name":"file","abstract":"

    Object type file

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO6folderyA2CmF":{"name":"folder","abstract":"

    Object type folder

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO7webLinkyA2CmF":{"name":"webLink","abstract":"

    Object type weblink

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type defined for searching that is not yet implemented.

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SearchItemType"},"Enums/SearchItemType.html#/s:6BoxSDK14SearchItemTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of searched item type.

    ","parent_name":"SearchItemType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO4nameyA2CmF":{"name":"name","abstract":"

    Searching in names of items

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11descriptionyA2CmF":{"name":"description","abstract":"

    Searching in description of items

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO12fileContentsyA2CmF":{"name":"fileContents","abstract":"

    Searching in files content

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO8commentsyA2CmF":{"name":"comments","abstract":"

    Searching in comments

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO4tagsyA2CmF":{"name":"tags","abstract":"

    Searching in tags

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom attribute defined for searching that is not yet implemented.

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"SearchContentType"},"Enums/SearchContentType.html#/s:6BoxSDK17SearchContentTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of search area type

    ","parent_name":"SearchContentType"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO4useryA2CmF":{"name":"user","abstract":"

    Scope limited to current user

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    Scope limited the enterprise.

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom search scope that is not yet implemented. To enable this type of scope for an administrator,","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"SearchScope"},"Enums/SearchScope.html#/s:6BoxSDK11SearchScopeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of scope.

    ","parent_name":"SearchScope"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO4noneyA2CmF":{"name":"none","abstract":"

    Preserve the existing value on the file

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO9overwriteyA2CmF":{"name":"overwrite","abstract":"

    Force-apply the cascade policy’s value over any existing value.

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK18ConflictResolutionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom conflict resolution method.

    ","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ConflictResolution"},"Enums/ConflictResolution.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"ConflictResolution"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO2idyA2CmF":{"name":"id","abstract":"

    Order by item identifier

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4nameyA2CmF":{"name":"name","abstract":"

    Order by item name

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4dateyA2CmF":{"name":"date","abstract":"

    Order by item date

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO4typeyA2CmF":{"name":"type","abstract":"

    Order by item type

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented by the SDk

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"FolderItemsOrderBy"},"Enums/FolderItemsOrderBy.html#/s:6BoxSDK18FolderItemsOrderByO15queryParamValueSSSgvp":{"name":"queryParamValue","abstract":"

    Query parameter value

    ","parent_name":"FolderItemsOrderBy"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO4openyA2CmF":{"name":"open","abstract":"

    Any user can upload.

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO13collaboratorsyA2CmF":{"name":"collaborators","abstract":"

    Any folder collaborator can upload

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access to a folder’s upload email address that is not yet implemented.

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer

    ","parent_name":"FolderUploadEmailAccess"},"Enums/FolderUploadEmailAccess.html#/s:6BoxSDK23FolderUploadEmailAccessO11descriptionSSvp":{"name":"description","abstract":"

    Returns a string representation of the folder upload email access

    ","parent_name":"FolderUploadEmailAccess"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO3jpgyA2CmF":{"name":"jpg","abstract":"

    The file extension for Joint Photographic Experts Group (JPEG) thumbnail images

    ","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO3pngyA2CmF":{"name":"png","abstract":"

    The file extension for Portable Network Graphic (PNG) thumbnail images

    ","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom file extension for thumbnail images that is not yet implemented. Check the list of","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ThumbnailExtension"},"Enums/ThumbnailExtension.html#/s:6BoxSDK18ThumbnailExtensionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of suffix

    ","parent_name":"ThumbnailExtension"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO6activeyA2CmF":{"name":"active","abstract":"

    Item was not deleted or moved to trash.

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO7trashedyA2CmF":{"name":"trashed","abstract":"

    Item has been moved to the trash

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO7deletedyA2CmF":{"name":"deleted","abstract":"

    Item has been permanently deleted

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK10ItemStatusO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"ItemStatus"},"Enums/ItemStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"ItemStatus"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO9newChangeyA2CmF":{"name":"newChange","abstract":"

    New event appeared.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO9reconnectyA2CmF":{"name":"reconnect","abstract":"

    No new events appeared. Request for a new polling URL.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Value that was not yet implemented in this SDK

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseOyACSScfc":{"name":"init(_:)","abstract":"

    Initializer.

    ","parent_name":"EventObserverResponse"},"Enums/EventObserverResponse.html#/s:6BoxSDK21EventObserverResponseO11descriptionSSvp":{"name":"description","abstract":"

    String representation of the reponse.

    ","parent_name":"EventObserverResponse"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO3allyA2CmF":{"name":"all","abstract":"

    Stream returns all user events

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO7changesyA2CmF":{"name":"changes","abstract":"

    Stream returns events that may cause file tree changes such as file updates or collaborations

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO4syncyA2CmF":{"name":"sync","abstract":"

    Stream returns enterprise-wide events available for administrators

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom stream type that is not yet implemented

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"StreamType"},"Enums/StreamType.html#/s:6BoxSDK10StreamTypeO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of StreamType

    ","parent_name":"StreamType"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO3nowyA2CmF":{"name":"now","abstract":"

    When used, Box API will return 0 events and the latest streamPosition value to be used for subsequent call.

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO4zeroyA2CmF":{"name":"zero","abstract":"

    When used, Box API will return all available events.

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom value of a stream position used when using value not yet implemented in this SDK (of similar usage as none, now or zero)

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"StreamPosition"},"Enums/StreamPosition.html#/s:6BoxSDK14StreamPositionO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of StreamPosition

    ","parent_name":"StreamPosition"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO4useryA2CmF":{"name":"user","abstract":"

    The user that is granted access

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO5groupyA2CmF":{"name":"group","abstract":"

    The group that is granted access

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom object type for defining access that is not yet implemented

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByOyACSScfc":{"name":"init(_:)","abstract":"

    Creates a new value

    ","parent_name":"AccessibleBy"},"Enums/AccessibleBy.html#/s:6BoxSDK12AccessibleByO11descriptionSSvp":{"name":"description","abstract":"

    Returns string representation of type that can be used in a request.

    ","parent_name":"AccessibleBy"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO12networkAgentyA2CmF":{"name":"networkAgent","abstract":"

    NetworkAgent related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO7modulesyA2CmF":{"name":"modules","abstract":"

    Module related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO6clientyA2CmF":{"name":"client","abstract":"

    BoxCLient related log

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO3sdkyA2CmF":{"name":"sdk","abstract":"

    The general log for BoxSDK

    ","parent_name":"LogCategory"},"Enums/LogCategory.html#/s:6BoxSDK11LogCategoryO11descriptionSSvp":{"name":"description","abstract":"

    Log category string title

    ","parent_name":"LogCategory"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5debugyA2CmF":{"name":"debug","abstract":"

    Logging only while debugging

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO4infoyA2CmF":{"name":"info","abstract":"

    Logging info message

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5erroryA2CmF":{"name":"error","abstract":"

    Logging error

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO5fatalyA2CmF":{"name":"fatal","abstract":"

    Logging fatal error

    ","parent_name":"LogLevel"},"Enums/LogLevel.html#/s:6BoxSDK8LogLevelO11descriptionSSvp":{"name":"description","abstract":"

    Log level string title

    ","parent_name":"LogLevel"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO10enterpriseyA2CmF":{"name":"enterprise","abstract":"

    The scope of the metadata template is set to the entire “enterprise”.

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO6globalyA2CmF":{"name":"global","abstract":"

    The scope of the metadata template is set to “global”

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK13MetadataScopeO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    A custom scope for metadata template.

    ","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"MetadataScope"},"Enums/MetadataScope.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"MetadataScope"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO8lessThanyA2CmF":{"name":"lessThan","abstract":"

    Inclusive upper bound parameter for field values of floats and dates.

    ","parent_name":"MetadataFilterBound"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO11greaterThanyA2CmF":{"name":"greaterThan","abstract":"

    Inclusive lower bound parameter for field values of floats and dates.

    ","parent_name":"MetadataFilterBound"},"Enums/MetadataFilterBound.html#/s:6BoxSDK19MetadataFilterBoundO5equalyA2CmF":{"name":"equal","abstract":"

    Set the filter value equal to filter key.

    ","parent_name":"MetadataFilterBound"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO15clientDestroyedyA2CmF":{"name":"clientDestroyed","abstract":"

    Box client was destroyed

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO10invalidURLyACSS_tcACmF":{"name":"invalidURL(urlString:)","abstract":"

    URL is invalid

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO8notFoundyACSScACmF":{"name":"notFound(_:)","abstract":"

    The requested resource was not found

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19instanceDeallocatedyACSScACmF":{"name":"instanceDeallocated(_:)","abstract":"

    Object needed in closure was deallocated

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO27keychainDataConversionErroryA2CmF":{"name":"keychainDataConversionError","abstract":"

    Could not decode or encode keychain data

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO15keychainNoValueyA2CmF":{"name":"keychainNoValue","abstract":"

    Value not found in Keychain

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO22keychainUnhandledErroryACSScACmF":{"name":"keychainUnhandledError(_:)","abstract":"

    Unhandled keychain error

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19rateLimitMaxRetriesyA2CmF":{"name":"rateLimitMaxRetries","abstract":"

    Request has hit the maximum number of retries

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12typeMismatchyACSS_tcACmF":{"name":"typeMismatch(key:)","abstract":"

    Value for key is of an unexpected type

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO13valueMismatchyACSS_SSSaySSGtcACmF":{"name":"valueMismatch(key:value:acceptedValues:)","abstract":"

    Value for key is not one of the accepted values

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO18invalidValueFormatyACSS_tcACmF":{"name":"invalidValueFormat(key:)","abstract":"

    Value for key is of a valid type, but was not able to convert value to expected type

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO10notPresentyACSS_tcACmF":{"name":"notPresent(key:)","abstract":"

    Key was not present

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO28representationCreationFailedyA2CmF":{"name":"representationCreationFailed","abstract":"

    The file representation couldn’t be made

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO17tokenStoreFailureyA2CmF":{"name":"tokenStoreFailure","abstract":"

    Error with TokenStore operation (write, read or clear)

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO14tokenRetrievalyA2CmF":{"name":"tokenRetrieval","abstract":"

    Unsuccessful token retrieval. Token not found

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO33invalidOAuthRedirectConfigurationyA2CmF":{"name":"invalidOAuthRedirectConfiguration","abstract":"

    OAuth web session authorization failed due to invalid redirect configuration

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO17invalidOAuthStateyA2CmF":{"name":"invalidOAuthState","abstract":"

    Couldn’t obtain authorization code from OAuth web session result

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO18unauthorizedAccessyA2CmF":{"name":"unauthorizedAccess","abstract":"

    Unauthorized request to API

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO20refreshTokenNotFoundyA2CmF":{"name":"refreshTokenNotFound","abstract":"

    Unsuccessful refresh token retrieval. Token not found in the retrieved TokenInfo object

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12expiredTokenyA2CmF":{"name":"expiredToken","abstract":"

    Access token has expired

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO12jwtAuthErroryA2CmF":{"name":"jwtAuthError","abstract":"

    Authorization with JWT token failed

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO19nonIterableResponseyA2CmF":{"name":"nonIterableResponse","abstract":"

    Couldn’t create paging iterable for non-paged response

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO9endOfListyA2CmF":{"name":"endOfList","abstract":"

    The end of the list was reached

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A12SDKErrorEnumO11customValueyACSScACmF":{"name":"customValue(_:)","abstract":"

    Custom error message

    ","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html#/s:s26ExpressibleByStringLiteralP06stringD0x0cD4TypeQz_tcfc":{"name":"init(stringLiteral:)","parent_name":"BoxSDKErrorEnum"},"Enums/BoxSDKErrorEnum.html":{"name":"BoxSDKErrorEnum","abstract":"

    Box SDK Error

    "},"Enums/MetadataFilterBound.html":{"name":"MetadataFilterBound","abstract":"

    Defines the the relation between the filter key and filter value of a metadata template.

    "},"Enums/MetadataScope.html":{"name":"MetadataScope","abstract":"

    Defines the scope of the metadata template.

    "},"Enums/LogLevel.html":{"name":"LogLevel","abstract":"

    Defines character of the log and when it will be displayed

    "},"Enums/LogCategory.html":{"name":"LogCategory","abstract":"

    Defines log category based on what kind of data is being logged

    "},"Enums/AccessibleBy.html":{"name":"AccessibleBy","abstract":"

    Specifies type of value that has granted access to an object.

    "},"Enums/StreamPosition.html":{"name":"StreamPosition","abstract":"

    Stream position used for stream pagination

    "},"Enums/StreamType.html":{"name":"StreamType","abstract":"

    Restricts the types of events returned.

    "},"Enums/EventObserverResponse.html":{"name":"EventObserverResponse","abstract":"

    Defines results for a request checking for new changes in user events

    "},"Enums/ItemStatus.html":{"name":"ItemStatus","abstract":"

    Box item status indicating whether this item is deleted or not.

    "},"Enums/ThumbnailExtension.html":{"name":"ThumbnailExtension","abstract":"

    Defines the file extension of a thumbnail image file.

    "},"Enums/FolderUploadEmailAccess.html":{"name":"FolderUploadEmailAccess","abstract":"

    Defines the level of access to upload a file to a folder via its upload email address

    "},"Enums/FolderItemsOrderBy.html":{"name":"FolderItemsOrderBy","abstract":"

    Defines by which parameter should list of box items be ordered.

    "},"Enums/ConflictResolution.html":{"name":"ConflictResolution","abstract":"

    The desired behavior for conflict-resolution if a template already exists on a given file or folder

    "},"Enums/SearchScope.html":{"name":"SearchScope","abstract":"

    Defines search scope

    "},"Enums/SearchContentType.html":{"name":"SearchContentType","abstract":"

    Defines the attributes for which the search should look for matches

    "},"Enums/SearchItemType.html":{"name":"SearchItemType","abstract":"

    Defines type of objects to include in the search results

    "},"Enums/TermsOfServiceStatus.html":{"name":"TermsOfServiceStatus","abstract":"

    Specifies whether the Terms of Service is currently active or inactive.

    "},"Enums/TermsOfServiceType.html":{"name":"TermsOfServiceType","abstract":"

    Specifies whether the ToS is managed by an enterprise or external to an enterprise.

    "},"Enums/UserStatus.html":{"name":"UserStatus","abstract":"

    Defines user status.

    "},"Enums/UserRole.html":{"name":"UserRole","abstract":"

    Defines user’s role within an enterprise

    "},"Enums/PagingParameter.html":{"name":"PagingParameter","abstract":"

    Stores offset, marker or stream position for the iterator

    "},"Enums/NullableParameter.html":{"name":"NullableParameter","abstract":"

    Type for updating optional parameters - parameters that can either have value of some type, or be nil."},"Enums/CollaborationStatus.html":{"name":"CollaborationStatus","abstract":"

    The status of the collaboration invitation.

    "},"Enums/CollaborationRole.html":{"name":"CollaborationRole","abstract":"

    The level of access granted. To see exactly which role has which permission, please look here

    "},"Enums/CollaborationDirection.html":{"name":"CollaborationDirection","abstract":"

    Direction of the collaboration

    "},"Enums/CollaborationItem.html":{"name":"CollaborationItem","abstract":"

    The file or folder that access is granted to by collaboration.

    "},"Enums/CommentItem.html":{"name":"CommentItem","abstract":"

    Item a comment was placed on

    "},"Enums/OrderDirection.html":{"name":"OrderDirection","abstract":"

    Order direction.

    "},"Enums/EventType.html":{"name":"EventType","abstract":"

    Defines user or enterprise event type

    "},"Enums/FileRepresentationHint.html":{"name":"FileRepresentationHint","abstract":"

    Defines the file type for the generated file representation

    "},"Enums/SyncState.html":{"name":"SyncState","abstract":"

    Defines whether folder will be synced by the Box sync clients or not.

    "},"Enums/FolderItem.html":{"name":"FolderItem","abstract":"

    Files, folders, or web links contained within a folder.

    "},"Enums/GroupInvitabilityLevel.html":{"name":"GroupInvitabilityLevel","abstract":"

    Specifies who can invite the group to collaborate on folders.

    "},"Enums/GroupMemberViewabilityLevel.html":{"name":"GroupMemberViewabilityLevel","abstract":"

    Specifies who can view the members of the group.

    "},"Enums/GroupRole.html":{"name":"GroupRole","abstract":"

    Specifies role of the user within a Group.

    "},"Enums/FileMetadataOperation.html":{"name":"FileMetadataOperation","abstract":"

    Operations on a file metadata

    "},"Enums/FolderMetadataOperation.html":{"name":"FolderMetadataOperation","abstract":"

    Operations on a folder metadata

    "},"Enums/MetadataTemplateOperation.html":{"name":"MetadataTemplateOperation","abstract":"

    Specifies opperations available on metadata template

    "},"Enums/RetentionPolicyType.html":{"name":"RetentionPolicyType","abstract":"

    The type of the retention policy.

    "},"Enums/DispositionAction.html":{"name":"DispositionAction","abstract":"

    The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    "},"Enums/RetentionPolicyStatus.html":{"name":"RetentionPolicyStatus","abstract":"

    The status of the retention policy.

    "},"Enums/RetentionPolicyAssignmentItemType.html":{"name":"RetentionPolicyAssignmentItemType","abstract":"

    Item type with task assignment.

    "},"Enums/TokenScope.html":{"name":"TokenScope","abstract":"

    Specifies permissions that define a token scope

    "},"Enums/SharedLinkAccess.html":{"name":"SharedLinkAccess","abstract":"

    Defines the level of access to the item by its shared link.

    "},"Enums/SignRequestStatus.html":{"name":"SignRequestStatus","abstract":"

    Describes the status of the sign request.

    "},"Enums/SignRequestSignerRole.html":{"name":"SignRequestSignerRole","abstract":"

    Defines the role of the signer in the sign request.

    "},"Enums/SignRequestSignerDecisionType.html":{"name":"SignRequestSignerDecisionType","abstract":"

    Type of decision made by the signer

    "},"Enums/SignRequestSignerInputType.html":{"name":"SignRequestSignerInputType","abstract":"

    Represents a type of input.

    "},"Enums/TaskCompletionRule.html":{"name":"TaskCompletionRule","abstract":"

    Defines the condition that will mark a task as complete

    "},"Enums/TaskAction.html":{"name":"TaskAction","abstract":"

    The action the task assignee will be prompted to perform

    "},"Enums/AssignmentStatus.html":{"name":"AssignmentStatus","abstract":"

    Status of assignment.

    "},"Enums/AssignmentState.html":{"name":"AssignmentState","abstract":"

    State of assignment.

    "},"Enums/TaskItem.html":{"name":"TaskItem","abstract":"

    Item a task is assigned to

    "},"Enums/WebhookItem.html":{"name":"WebhookItem","abstract":"

    Files, folders, or web links associated with a webhook.

    "},"Classes/KeychainTokenStore.html#/s:6BoxSDK18KeychainTokenStoreCACycfc":{"name":"init()","abstract":"

    Initializer method

    ","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP4read10completionyys6ResultOyAA0C4InfoCs5Error_pGc_tF":{"name":"read(completion:)","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP5write9tokenInfo10completionyAA0cG0C_ys6ResultOyyts5Error_pGctF":{"name":"write(tokenInfo:completion:)","parent_name":"KeychainTokenStore"},"Classes/KeychainTokenStore.html#/s:6BoxSDK10TokenStoreP5clear10completionyys6ResultOyyts5Error_pGc_tF":{"name":"clear(completion:)","parent_name":"KeychainTokenStore"},"Classes/SingleTokenSession.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","parent_name":"SingleTokenSession"},"Classes/SingleTokenSession.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","parent_name":"SingleTokenSession"},"Classes/SingleTokenSession.html#/s:6BoxSDK18SingleTokenSessionC09downscopeD05scope8resource10sharedLink10completionyShyAA0D5ScopeOG_SSSgALys6ResultOyAA0D4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"SingleTokenSession"},"Classes/OAuth2Session.html#/s:6BoxSDK15SessionProtocolP14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK20ExpiredTokenHandlingP06handlecD010completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"handleExpiredToken(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK13OAuth2SessionC12refreshToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"refreshToken(completion:)","abstract":"

    Gets refreshed access token if necessary

    ","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK15SessionProtocolP12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","parent_name":"OAuth2Session"},"Classes/OAuth2Session.html#/s:6BoxSDK13OAuth2SessionC14downscopeToken5scope8resource10sharedLink10completionyShyAA0F5ScopeOG_SSSgALys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"OAuth2Session"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC12revokeTokens10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"revokeTokens(completion:)","abstract":"

    Revokes token

    ","parent_name":"DelegatedAuthSession"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC14getAccessToken10completionyys6ResultOySSAA0A8SDKErrorCGc_tF":{"name":"getAccessToken(completion:)","abstract":"

    Retrieves valid access token

    ","parent_name":"DelegatedAuthSession"},"Classes/DelegatedAuthSession.html#/s:6BoxSDK20DelegatedAuthSessionC14downscopeToken5scope8resource10sharedLink10completionyShyAA0G5ScopeOG_SSSgALys6ResultOyAA0G4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"DelegatedAuthSession"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC14totalFileCountSivp":{"name":"totalFileCount","abstract":"

    The total number of files in the zip

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC19downloadedFileCountSivp":{"name":"downloadedFileCount","abstract":"

    The number of files in the zip that were downloaded

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC16skippedFileCountSivp":{"name":"skippedFileCount","abstract":"

    The number of files that were skipped when downloading

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC18skippedFolderCountSivp":{"name":"skippedFolderCount","abstract":"

    The number of folders that were skipped when downloading

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC5stateSSvp":{"name":"state","abstract":"

    State of the download for the zip file

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC13nameConflictsSayAA0cD8ConflictCGSgvp":{"name":"nameConflicts","abstract":"

    Conflicts that occur between items that have the same name. This is always initially nil and updated manually later, via the FilesModule.getZipDownloadStatus() method.

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadStatus.html#/s:6BoxSDK17ZipDownloadStatusC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadStatus"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC2idSSvp":{"name":"id","abstract":"

    Identfier

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC4typeSSvp":{"name":"type","abstract":"

    Box item type - file or folder.

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC12originalNameSSvp":{"name":"originalName","abstract":"

    The original name of the item that has the conflict

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC12downloadNameSSvp":{"name":"downloadName","abstract":"

    The new name of the item when it downloads that resolves the conflict

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflictItem.html#/s:6BoxSDK23ZipDownloadConflictItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadConflictItem"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownloadConflict"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK19ZipDownloadConflictC8conflictSayAA0cdE4ItemCGSgvp":{"name":"conflict","abstract":"

    Conflict that occurs between items that have the same name.

    ","parent_name":"ZipDownloadConflict"},"Classes/ZipDownloadConflict.html#/s:6BoxSDK19ZipDownloadConflictC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownloadConflict"},"Classes/ZipDownload.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC11downloadUrl10Foundation3URLVvp":{"name":"downloadUrl","abstract":"

    The URL to download the Zip file. If entered in a browser, this URL will trigger a download of the Zip file.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC9statusUrl10Foundation3URLVvp":{"name":"statusUrl","abstract":"

    The URL to monitor the status of the download.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    Expiration date of the Zip file download.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC13nameConflictsSayAA0cD8ConflictCGSgvp":{"name":"nameConflicts","abstract":"

    Conflicts that occur between items that have the same name.

    ","parent_name":"ZipDownload"},"Classes/ZipDownload.html#/s:6BoxSDK11ZipDownloadC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ZipDownload"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileUploadedyA2EmF":{"name":"fileUploaded","abstract":"

    A file is uploaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13filePreviewedyA2EmF":{"name":"filePreviewed","abstract":"

    A file is previewed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14fileDownloadedyA2EmF":{"name":"fileDownloaded","abstract":"

    A file is downloaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileTrashedyA2EmF":{"name":"fileTrashed","abstract":"

    A file is moved to the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileDeletedyA2EmF":{"name":"fileDeleted","abstract":"

    A file is permanently deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileRestoredyA2EmF":{"name":"fileRestored","abstract":"

    A file is restored from the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO10fileCopiedyA2EmF":{"name":"fileCopied","abstract":"

    A file is copied

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO9fileMovedyA2EmF":{"name":"fileMoved","abstract":"

    A file is moved from one folder to another

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO10fileLockedyA2EmF":{"name":"fileLocked","abstract":"

    A file is locked

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12fileUnlockedyA2EmF":{"name":"fileUnlocked","abstract":"

    A file is unlocked

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11fileRenamedyA2EmF":{"name":"fileRenamed","abstract":"

    A file was renamed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentCreatedyA2EmF":{"name":"commentCreated","abstract":"

    A comment object is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentUpdatedyA2EmF":{"name":"commentUpdated","abstract":"

    A comment object is edited

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14commentDeletedyA2EmF":{"name":"commentDeleted","abstract":"

    A comment object is removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21taskAssignmentCreatedyA2EmF":{"name":"taskAssignmentCreated","abstract":"

    A task is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21taskAssignmentUpdatedyA2EmF":{"name":"taskAssignmentUpdated","abstract":"

    A task assignment is changed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceCreatedyA2EmF":{"name":"metadataInstanceCreated","abstract":"

    A new metadata template instance is associated with a file or folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceUpdatedyA2EmF":{"name":"metadataInstanceUpdated","abstract":"

    An attribute (value) is updated/deleted for an existing metadata template instance associated with a file or folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO23metadataInstanceDeletedyA2EmF":{"name":"metadataInstanceDeleted","abstract":"

    An existing metadata template instance associated with a file or folder is deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderCreatedyA2EmF":{"name":"folderCreated","abstract":"

    A folder is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderRenamedyA2EmF":{"name":"folderRenamed","abstract":"

    A folder was renamed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO16folderDownloadedyA2EmF":{"name":"folderDownloaded","abstract":"

    A folder is downloaded

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14folderRestoredyA2EmF":{"name":"folderRestored","abstract":"

    A folder is restored from the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderDeletedyA2EmF":{"name":"folderDeleted","abstract":"

    A folder is permanently removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO12folderCopiedyA2EmF":{"name":"folderCopied","abstract":"

    A copy of a folder is made

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11folderMovedyA2EmF":{"name":"folderMoved","abstract":"

    A folder is moved to a different folder

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO13folderTrashedyA2EmF":{"name":"folderTrashed","abstract":"

    A folder is moved to the trash

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO14webhookDeletedyA2EmF":{"name":"webhookDeleted","abstract":"

    When a webhook is deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationCreatedyA2EmF":{"name":"collaborationCreated","abstract":"

    A collaboration is created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21collaborationAcceptedyA2EmF":{"name":"collaborationAccepted","abstract":"

    A collaboration has been accepted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO21collaborationRejectedyA2EmF":{"name":"collaborationRejected","abstract":"

    A collaboration has been rejected

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationRemovedyA2EmF":{"name":"collaborationRemoved","abstract":"

    A collaboration has been removed

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO20collaborationUpdatedyA2EmF":{"name":"collaborationUpdated","abstract":"

    A collaboration has been updated

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkDeletedyA2EmF":{"name":"sharedLinkDeleted","abstract":"

    A shared link was deleted

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkCreatedyA2EmF":{"name":"sharedLinkCreated","abstract":"

    A shared link was created

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO17sharedLinkUpdatedyA2EmF":{"name":"sharedLinkUpdated","abstract":"

    A shared link was updated

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK7WebhookC13EventTriggersO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"EventTriggers"},"Classes/Webhook/EventTriggers.html":{"name":"EventTriggers","abstract":"

    Event triggers for webhooks

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC6targetAA0C4ItemOSgvp":{"name":"target","abstract":"

    Target information

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    User that created the webhook

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    Timestamp of when webhook was created

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC7address10Foundation3URLVSgvp":{"name":"address","abstract":"

    URL to which notifications are sent

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC8triggersSayAC13EventTriggersOGSgvp":{"name":"triggers","abstract":"

    Events that activate the webhook

    ","parent_name":"Webhook"},"Classes/Webhook.html#/s:6BoxSDK7WebhookC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Webhook"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Can rename web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Can delete web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV10canCommentSbSgvp":{"name":"canComment","abstract":"

    Can comment on web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Can share web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html#/s:6BoxSDK7WebLinkC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Can set share access for web link

    ","parent_name":"Permissions"},"Classes/WebLink/Permissions.html":{"name":"Permissions","abstract":"

    Web link permissions

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this web link. Used with If-Match headers.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4nameSSSgvp":{"name":"name","abstract":"

    The name of this web link.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    The URL this web link points to.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When this web link was created

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this web link was last updated

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    The parent object the web link belongs to.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC11descriptionSSSgvp":{"name":"description","abstract":"

    The description accompanying the web link. This is visible within the Box web application.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10itemStatusAA04ItemF0OSgvp":{"name":"itemStatus","abstract":"

    Status of the web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When this web link was last moved to the trash

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When this web link will be permanently deleted.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC06sharedD0AA06SharedD0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this web link. Is nil if no shared link has been created.

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC14pathCollectionAA04PathF0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this link, starting at the root

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last modified this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this web link

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Web link permissions

    ","parent_name":"WebLink"},"Classes/WebLink.html#/s:6BoxSDK7WebLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"WebLink"},"Classes/Watermark.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC11resourceKeySSvpZ":{"name":"resourceKey","abstract":"

    Key for watermark data JSON object

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC10imprintKeySSvpZ":{"name":"imprintKey","abstract":"

    Key for imprint data in JSON object

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC14defaultImprintSSvpZ":{"name":"defaultImprint","abstract":"

    Default imprint text

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time this watermark was created.

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time this watermark was last modified.

    ","parent_name":"Watermark"},"Classes/Watermark.html#/s:6BoxSDK9WatermarkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Watermark"},"Classes/User/TrackingCode.html#/s:6BoxSDK4UserC12TrackingCodeV4nameSSvp":{"name":"name","abstract":"

    Code name

    ","parent_name":"TrackingCode"},"Classes/User/TrackingCode.html#/s:6BoxSDK4UserC12TrackingCodeV5valueSSvp":{"name":"value","abstract":"

    Code value

    ","parent_name":"TrackingCode"},"Classes/User/TrackingCode.html":{"name":"TrackingCode","abstract":"

    A custom values set by the user’s admin to track user’s activity.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4nameSSSgvp":{"name":"name","abstract":"

    The name of the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC5loginSSSgvp":{"name":"login","abstract":"

    The email address the user uses to log in.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the user object was created.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the user object was last modified.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8languageSSSgvp":{"name":"language","abstract":"

    The user’s preferred language.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8timezoneSSSgvp":{"name":"timezone","abstract":"

    The user’s timezone.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC11spaceAmountSiSgvp":{"name":"spaceAmount","abstract":"

    The user’s total available space amount in bytes.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9spaceUsedSiSgvp":{"name":"spaceUsed","abstract":"

    The amount of space in use by the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13maxUploadSizeSiSgvp":{"name":"maxUploadSize","abstract":"

    The maximum individual file size in bytes the user can have.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC6statusAA0C6StatusOSgvp":{"name":"status","abstract":"

    User’s status.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8jobTitleSSSgvp":{"name":"jobTitle","abstract":"

    The user’s job title.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC5phoneSSSgvp":{"name":"phone","abstract":"

    The user’s phone number.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC7addressSSSgvp":{"name":"address","abstract":"

    The user’s address.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC9avatarUrl10Foundation3URLVSgvp":{"name":"avatarUrl","abstract":"

    URL of the user’s avatar image.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4roleSSSgvp":{"name":"role","abstract":"

    The user’s enterprise role.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13trackingCodesSayAC12TrackingCodeVGSgvp":{"name":"trackingCodes","abstract":"

    An array of key/value pairs set by the user’s admin.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC18canSeeManagedUsersSbSgvp":{"name":"canSeeManagedUsers","abstract":"

    Whether the user can see other enterprise users in their contact list.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC13isSyncEnabledSbSgvp":{"name":"isSyncEnabled","abstract":"

    Whether the user can use Box Sync.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC26isExternalCollabRestrictedSbSgvp":{"name":"isExternalCollabRestricted","abstract":"

    Whether the user is allowed to collaborate with users outside her enterprise.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC24isExemptFromDeviceLimitsSbSgvp":{"name":"isExemptFromDeviceLimits","abstract":"

    Whether to exempt the user from Enterprise device limits.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC29isExemptFromLoginVerificationSbSgvp":{"name":"isExemptFromLoginVerification","abstract":"

    Whether the user must use two-factor authentication.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the user’s enterprise.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC6myTagsSaySSGSgvp":{"name":"myTags","abstract":"

    Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC8hostnameSSSgvp":{"name":"hostname","abstract":"

    The root (protocol, subdomain, domain) of any links that need to be generated for the user.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC20isPlatformAccessOnlySbSgvp":{"name":"isPlatformAccessOnly","abstract":"

    Whether the user is an App User.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC011externalAppC2IdSSSgvp":{"name":"externalAppUserId","abstract":"

    External app user ID.

    ","parent_name":"User"},"Classes/User.html#/s:6BoxSDK4UserC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"User"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV9listParts10Foundation3URLVSgvp":{"name":"listParts","abstract":"

    List parts endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV6commit10Foundation3URLVSgvp":{"name":"commit","abstract":"

    Commit part endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV8logEvent10Foundation3URLVSgvp":{"name":"logEvent","abstract":"

    Log event endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV10uploadPart10Foundation3URLVSgvp":{"name":"uploadPart","abstract":"

    Upload part endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV6status10Foundation3URLVSgvp":{"name":"status","abstract":"

    Upload status endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html#/s:6BoxSDK13UploadSessionC0cD9EndpointsV5abort10Foundation3URLVSgvp":{"name":"abort","abstract":"

    Abort upload endpoint

    ","parent_name":"UploadSessionEndpoints"},"Classes/UploadSession/UploadSessionEndpoints.html":{"name":"UploadSessionEndpoints","abstract":"

    Internal struct containing URLs for upload session manipulation

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC10totalPartsSivp":{"name":"totalParts","abstract":"

    Count of uploaded parts

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC8partSizeSivp":{"name":"partSize","abstract":"

    Size of uploaded part. Each part’s size must be exactly equal in size to the part size specified","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC17numPartsProcessedSivp":{"name":"numPartsProcessed","abstract":"

    Number of parts processed

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC16sessionExpiresAt10Foundation4DateVvp":{"name":"sessionExpiresAt","abstract":"

    The validity end of this session

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC16sessionEndpointsAC0cdF0Vvp":{"name":"sessionEndpoints","abstract":"

    Set of URL for upload session management

    ","parent_name":"UploadSession"},"Classes/UploadSession.html#/s:6BoxSDK13UploadSessionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"UploadSession"},"Classes/UploadPart.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"UploadPart"},"Classes/UploadPart.html#/s:6BoxSDK10UploadPartC4partAA0cD11DescriptionVvp":{"name":"part","abstract":"

    Part description object

    ","parent_name":"UploadPart"},"Classes/UploadPart.html#/s:6BoxSDK10UploadPartC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"UploadPart"},"Classes/TrackingCode.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC4nameSSvp":{"name":"name","abstract":"

    Tracking code key.

    ","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC5valueSSvp":{"name":"value","abstract":"

    Tracking code value.

    ","parent_name":"TrackingCode"},"Classes/TrackingCode.html#/s:6BoxSDK12TrackingCodeC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TrackingCode"},"Classes/TokenInfo.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC06accessC007refreshC09expiresIn9tokenTypeACSS_SSSgSdSStcfc":{"name":"init(accessToken:refreshToken:expiresIn:tokenType:)","abstract":"

    Initializer

    ","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC06accessC09expiresInACSS_Sdtcfc":{"name":"init(accessToken:expiresIn:)","abstract":"

    Initializer.

    ","parent_name":"TokenInfo"},"Classes/TokenInfo.html#/s:6BoxSDK9TokenInfoC2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compares tokens

    ","parent_name":"TokenInfo"},"Classes/Token.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC06accessC0SSSgvp":{"name":"accessToken","abstract":"

    Access token.

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC9expiresInSiSgvp":{"name":"expiresIn","abstract":"

    Expiration time interval since

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC9tokenTypeSSSgvp":{"name":"tokenType","abstract":"

    Type of token

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC12restrictedToSayAA5ScopeCGSgvp":{"name":"restrictedTo","abstract":"

    Token permissions

    ","parent_name":"Token"},"Classes/Token.html#/s:6BoxSDK5TokenC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Token"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC2idSSvp":{"name":"id","abstract":"

    The ID of the user status object for the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC3tosAA0cdE0CSgvp":{"name":"tos","abstract":"

    The Terms of Service this status is associated with.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4userAA0F0CSgvp":{"name":"user","abstract":"

    The user that is associated with the current status of the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC10isAcceptedSbSgvp":{"name":"isAccepted","abstract":"

    Indicator as to whether or not the user has accepted the Terms of Service.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date the user status for the ToS was created.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date the user status for the ToS was modified.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfServiceUserStatus.html#/s:6BoxSDK24TermsOfServiceUserStatusC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceUserStatus"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC6statusAA0cdE6StatusOSgvp":{"name":"status","abstract":"

    An enum indicating whether the ToS is currently active or inactive.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    A mini Box enterprise object that the ToS is associated with.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC7tosTypeAA0cdeG0OSgvp":{"name":"tosType","abstract":"

    The scope of the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4textSSSgvp":{"name":"text","abstract":"

    The agreement of the ToS specified for the user in the custom application.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date created at for the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date modified at for the ToS.

    ","parent_name":"TermsOfService"},"Classes/TermsOfService.html#/s:6BoxSDK14TermsOfServiceC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfService"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    File an assignment is on.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    Date of assignment.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC6statusAA0D6StatusOSgvp":{"name":"status","abstract":"

    Assignment status.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC7messageSSSgvp":{"name":"message","abstract":"

    A message from the assignee about this task.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedToAA4UserCSgvp":{"name":"assignedTo","abstract":"

    The user task is assigned to.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    The user task is assigned by.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC15resolutionStateAA0dF0OSgvp":{"name":"resolutionState","abstract":"

    State of assignment. Can be completed, incomplete, approved, or rejected.

    ","parent_name":"TaskAssignment"},"Classes/TaskAssignment.html#/s:6BoxSDK14TaskAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TaskAssignment"},"Classes/Task.html#/s:6BoxSDK4TaskC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The file associated with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC5dueAt10Foundation4DateVSgvp":{"name":"dueAt","abstract":"

    When the task is due.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC6actionAA0C6ActionOSgvp":{"name":"action","abstract":"

    The action the task assignee will be prompted to do. Depending on task type, this can be “review” or “complete”.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC7messageSSSgvp":{"name":"message","abstract":"

    A message that will be included with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC24taskAssignmentCollectionAA14EntryContainerCyAA0cE0CGSgvp":{"name":"taskAssignmentCollection","abstract":"

    A collection of mini task_assignment objects associated with the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC11isCompletedSbSgvp":{"name":"isCompleted","abstract":"

    Whether the task has been completed.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the task.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the task object was created.

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC14completionRuleAA0c10CompletionE0OSgvp":{"name":"completionRule","abstract":"

    The rule that determines whether a task is completed

    ","parent_name":"Task"},"Classes/Task.html#/s:6BoxSDK4TaskC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Task"},"Classes/StoragePolicyAssignment/AssignedTo.html#/s:6BoxSDK23StoragePolicyAssignmentC10AssignedToV4typeSSvp":{"name":"type","abstract":"

    Type of item storage policy is assigned to

    ","parent_name":"AssignedTo"},"Classes/StoragePolicyAssignment/AssignedTo.html#/s:6BoxSDK23StoragePolicyAssignmentC10AssignedToV2idSSvp":{"name":"id","abstract":"

    Id of item storage policy is assigned to

    ","parent_name":"AssignedTo"},"Classes/StoragePolicyAssignment/AssignedTo.html":{"name":"AssignedTo","abstract":"

    Enterprise storage policy is assigned to

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Id of the storage policy assignment

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC07storageD0AA0cD0CSgvp":{"name":"storagePolicy","abstract":"

    Storage policy

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC10assignedToAC08AssignedG0VSgvp":{"name":"assignedTo","abstract":"

    Enterprise the storage policy is assigned to

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicyAssignment.html#/s:6BoxSDK23StoragePolicyAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StoragePolicyAssignment"},"Classes/StoragePolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC2idSSvp":{"name":"id","abstract":"

    Id of the storage policy

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4nameSSSgvp":{"name":"name","abstract":"

    Name for a storage zone

    ","parent_name":"StoragePolicy"},"Classes/StoragePolicy.html#/s:6BoxSDK13StoragePolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StoragePolicy"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC4typeAA0cdeF4TypeOSgvp":{"name":"type","abstract":"

    Type of input

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC9pageIndexSivp":{"name":"pageIndex","abstract":"

    Index of page that the input is on

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC13documentTagIdSSSgvp":{"name":"documentTagId","abstract":"

    This references the ID of a specific tag contained in a file of the sign request

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC9textValueSSSgvp":{"name":"textValue","abstract":"

    Text prefill value

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC13checkboxValueSbSgvp":{"name":"checkboxValue","abstract":"

    Checkbox prefill value

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC9dateValue10Foundation4DateVSgvp":{"name":"dateValue","abstract":"

    Date prefill value

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerInput.html#/s:6BoxSDK22SignRequestSignerInputC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestSignerInput"},"Classes/SignRequestSignerDecision.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequestSignerDecision"},"Classes/SignRequestSignerDecision.html#/s:6BoxSDK25SignRequestSignerDecisionC4typeAA0cdeF4TypeOSgvp":{"name":"type","abstract":"

    Type of decision made by the signer

    ","parent_name":"SignRequestSignerDecision"},"Classes/SignRequestSignerDecision.html#/s:6BoxSDK25SignRequestSignerDecisionC11finalizedAt10Foundation4DateVSgvp":{"name":"finalizedAt","abstract":"

    Date and Time that the decision was made

    ","parent_name":"SignRequestSignerDecision"},"Classes/SignRequestSignerDecision.html#/s:6BoxSDK25SignRequestSignerDecisionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestSignerDecision"},"Classes/SignRequestSigner.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC5emailSSvp":{"name":"email","abstract":"

    Email address of the signer

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC4roleAA0cdE4RoleOSgvp":{"name":"role","abstract":"

    Role of the signer

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC10isInPersonSbSgvp":{"name":"isInPerson","abstract":"

    Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next inPerson signer.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC5orderSiSgvp":{"name":"order","abstract":"

    Order of the signer.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC22embedUrlExternalUserIdSSSgvp":{"name":"embedUrlExternalUserId","abstract":"

    User ID for the signer in an external application responsible for authentication when accessing the embed URL.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC17hasViewedDocumentSbSgvp":{"name":"hasViewedDocument","abstract":"

    Flag which indicating if signer has viewed the document.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC14signerDecisionAA0cdeG0CSgvp":{"name":"signerDecision","abstract":"

    Final decision made by the signer.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC6inputsSayAA0cdE5InputCGSgvp":{"name":"inputs","abstract":"

    Inputs created by a signer on a sign request.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC8embedUrlSSSgvp":{"name":"embedUrl","abstract":"

    URL to direct a signer to for signing.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSigner.html#/s:6BoxSDK17SignRequestSignerC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestSigner"},"Classes/SignRequestSignFiles.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequestSignFiles"},"Classes/SignRequestSignFiles.html#/s:6BoxSDK011SignRequestC5FilesC5filesSayAA4FileCGSgvp":{"name":"files","abstract":"

    Files that signing events will occur on - these are copies of the original source files.

    ","parent_name":"SignRequestSignFiles"},"Classes/SignRequestSignFiles.html#/s:6BoxSDK011SignRequestC5FilesC18isReadyForDownloadSbSgvp":{"name":"isReadyForDownload","abstract":"

    Indicates whether the signFiles documents are processing and the PDFs may be out of date.","parent_name":"SignRequestSignFiles"},"Classes/SignRequestSignFiles.html#/s:6BoxSDK011SignRequestC5FilesC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestSignFiles"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC08documentF2IdSSSgvp":{"name":"documentTagId","abstract":"

    This references the ID of a specific tag contained in a file of the sign request

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC9textValueSSSgvp":{"name":"textValue","abstract":"

    Text prefill value

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC13checkboxValueSbSgvp":{"name":"checkboxValue","abstract":"

    Checkbox prefill value

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC9dateValue10Foundation4DateVSgvp":{"name":"dateValue","abstract":"

    Date prefill value

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC08documentF2Id9textValueACSSSg_AFtcfc":{"name":"init(documentTagId:textValue:)","abstract":"

    Initializer.

    ","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC08documentF2Id13checkboxValueACSSSg_SbSgtcfc":{"name":"init(documentTagId:checkboxValue:)","parent_name":"SignRequestPrefillTag"},"Classes/SignRequestPrefillTag.html#/s:6BoxSDK21SignRequestPrefillTagC08documentF2Id9dateValueACSSSg_10Foundation4DateVSgtcfc":{"name":"init(documentTagId:dateValue:)","parent_name":"SignRequestPrefillTag"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC7signersSayAA0cD6SignerCGvp":{"name":"signers","abstract":"

    Signers for the sign request.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC2idSSvp":{"name":"id","abstract":"

    Sign request ID

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC10prepareUrlSSSgvp":{"name":"prepareUrl","abstract":"

    This URL is returned if isDocumentPreparationNeeded is set to true in the request.","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC10signingLogAA4FileCSgvp":{"name":"signingLog","abstract":"

    Reference to a file that holds a log of all signer activity for the request.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC6statusAA0cD6StatusOSgvp":{"name":"status","abstract":"

    Status of the sign request.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC9signFilesAA0cdcF0CSgvp":{"name":"signFiles","abstract":"

    List of files that will be signed, which are copies of the original source files.","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC12autoExpireAt10Foundation4DateVSgvp":{"name":"autoExpireAt","abstract":"

    Uses daysValid to calculate the date and time, the sign request will expire if unsigned.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC27isDocumentPreparationNeededSbSgvp":{"name":"isDocumentPreparationNeeded","abstract":"

    Indicates if the sender should receive a prepareUrl in the response to complete document preparation via UI.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC24areTextSignaturesEnabledSbSgvp":{"name":"areTextSignaturesEnabled","abstract":"

    Disables the usage of signatures generated by typing (text). Default is true.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC12emailSubjectSSSgvp":{"name":"emailSubject","abstract":"

    Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC12emailMessageSSSgvp":{"name":"emailMessage","abstract":"

    Message to include in sign request email. The field is cleaned through sanitization of specific characters.","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC19areRemindersEnabledSbSgvp":{"name":"areRemindersEnabled","abstract":"

    Flag indicating if remind signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC11sourceFilesSayAA4FileCGvp":{"name":"sourceFiles","abstract":"

    List of files to create a signing document from.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC12parentFolderAA0F0Cvp":{"name":"parentFolder","abstract":"

    The destination folder to place final, signed document and signing log.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC11prefillTagsSayAA0cD10PrefillTagCGSgvp":{"name":"prefillTags","abstract":"

    List of prefill tags.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC9daysValidSiSgvp":{"name":"daysValid","abstract":"

    Number of days after which this request will automatically expire if not completed.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC10externalIdSSSgvp":{"name":"externalId","abstract":"

    A reference ID in an external system that the sign request is related to.

    ","parent_name":"SignRequest"},"Classes/SignRequest.html#/s:6BoxSDK11SignRequestC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SignRequest"},"Classes/SharedLink/Permissions.html#/s:6BoxSDK10SharedLinkC11PermissionsV10canPreviewSbSgvp":{"name":"canPreview","abstract":"

    Whether the shared link allows previewing. For shared links on folders, this also applies to any items in the folder.

    ","parent_name":"Permissions"},"Classes/SharedLink/Permissions.html#/s:6BoxSDK10SharedLinkC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Whether the shared link allows downloads. For shared links on folders, this also applies to any items in the folder.

    ","parent_name":"Permissions"},"Classes/SharedLink/Permissions.html":{"name":"Permissions","abstract":"

    Permission for a user accessing item by shared link

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    The URL to access the item on Box. If entered in a browser, this URL will display the item in Box’s preview UI.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC11downloadURL10Foundation0F0VSgvp":{"name":"downloadURL","abstract":"

    The “direct Link” URL to download the item. If entered in a browser, this URL will trigger a download of the item.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC9vanityURL10Foundation0F0VSgvp":{"name":"vanityURL","abstract":"

    The “Custom URL” that can also be used to preview the item on Box.","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC15effectiveAccessSSSgvp":{"name":"effectiveAccess","abstract":"

    The effective access level for the shared link. This can be lower than the value in the access field","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC19effectivePermissionSSSgvp":{"name":"effectivePermission","abstract":"

    Actual permissions that are allowed by the shared link, taking into account enterprise and user settings.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC17isPasswordEnabledSbSgvp":{"name":"isPasswordEnabled","abstract":"

    Whether the shared link has a password set.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC10unsharedAt10Foundation4DateVSgvp":{"name":"unsharedAt","abstract":"

    The date-time that this link will become disabled. This field can only be set by users with paid accounts.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC13downloadCountSiSgvp":{"name":"downloadCount","abstract":"

    The number of times the item has been downloaded.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC12previewCountSiSgvp":{"name":"previewCount","abstract":"

    The number of times the item has been previewed.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC6accessAA0cD6AccessOSgvp":{"name":"access","abstract":"

    The access level specified when the shared link was created.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Permissions for download and preview of the item.

    ","parent_name":"SharedLink"},"Classes/SharedLink.html#/s:6BoxSDK10SharedLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SharedLink"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"SharedItemType"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"SharedItemType"},"Classes/SharedItem/SharedItemType.html#/s:6BoxSDK10SharedItemC0cD4TypeO7webLinkyAeA03WebG0CcAEmF":{"name":"webLink(_:)","abstract":"

    Web link type

    ","parent_name":"SharedItemType"},"Classes/SharedItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SharedItem"},"Classes/SharedItem/SharedItemType.html":{"name":"SharedItemType","abstract":"

    Type of shared item

    ","parent_name":"SharedItem"},"Classes/SharedItem.html#/s:6BoxSDK10SharedItemC9itemValueAC0cD4TypeOvp":{"name":"itemValue","abstract":"

    Shared item value

    ","parent_name":"SharedItem"},"Classes/SharedItem.html#/s:6BoxSDK10SharedItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SharedItem"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC23accessibleViaSharedLink10Foundation3URLVSgvp":{"name":"accessibleViaSharedLink","abstract":"

    The optional shared link through which the user has access to this item.","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4itemAA10FolderItemOvp":{"name":"item","abstract":"

    The file, folder or web link that matched the search query.

    ","parent_name":"SearchResult"},"Classes/SearchResult.html#/s:6BoxSDK12SearchResultC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"SearchResult"},"Classes/Scope.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC5scopeSSSgvp":{"name":"scope","abstract":"

    Scope permission

    ","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC6objectAA4FileCSgvp":{"name":"object","abstract":"

    The file scope is applied to

    ","parent_name":"Scope"},"Classes/Scope.html#/s:6BoxSDK5ScopeC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Scope"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK20RetentionPolicyEntryC4nameSSSgvp":{"name":"name","abstract":"

    The name of the retention policy.

    ","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyEntry.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicyEntry"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC2idSSSgvp":{"name":"id","abstract":"

    ID of the content that is under retention.","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC4typeAA0cdeF4TypeOSgvp":{"name":"type","abstract":"

    Type of the content that is under retention.

    ","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignmentItem.html#/s:6BoxSDK29RetentionPolicyAssignmentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"RetentionPolicyAssignmentItem"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC09retentionD0AA0cD0CSgvp":{"name":"retentionPolicy","abstract":"

    A mini retention policy object representing the retention policy that has been assigned to this content.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedToAA0cdE4ItemCSgvp":{"name":"assignedTo","abstract":"

    Content that is under retention. The type can either be folder or enterprise.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    A mini user object representing the user that created the retention policy assignment object.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    When the retention policy assignment object was created.

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK25RetentionPolicyAssignmentC12filterFieldsSayAA19MetadataFieldFilterVGSgvp":{"name":"filterFields","abstract":"

    The array of metadata field filters, if present

    ","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicyAssignment.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicyAssignment"},"Classes/RetentionPolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC4nameSSSgvp":{"name":"name","abstract":"

    The name of the retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC10policyTypeAA0cdF0OSgvp":{"name":"policyType","abstract":"

    The type of the retention policy based on whether the amount of time to retain content is known or unknown.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC15retentionLengthSiSgvp":{"name":"retentionLength","abstract":"

    The length of the retention policy. This length specifies the duration in days that the retention policy will be active","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC17dispositionActionAA011DispositionF0OSgvp":{"name":"dispositionAction","abstract":"

    The disposition action of the retention policy specifying what will happen once the retention policy time period has passed.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC6statusAA0cD6StatusOSgvp":{"name":"status","abstract":"

    The status of the retention policy. Can be either active or retired. Once a policy has been retired, it cannot become active again.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    A mini user object representing the user that created the retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the retention policy object was created.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the retention policy object was last modified.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC014canOwnerExtendC0SbSgvp":{"name":"canOwnerExtendRetention","abstract":"

    Wheter owner can extend time of retention policy.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC17areOwnersNotifiedSbSgvp":{"name":"areOwnersNotified","abstract":"

    Whether owners are notified about retention policy changes.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK15RetentionPolicyC28customNotificationRecipientsSayAA4UserCGSgvp":{"name":"customNotificationRecipients","abstract":"

    Other users notified about retention policy changes.

    ","parent_name":"RetentionPolicy"},"Classes/RetentionPolicy.html#/s:6BoxSDK0A5ModelP4jsonxSDySSypG_tKcfc":{"name":"init(json:)","parent_name":"RetentionPolicy"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11itemPreviewyA2EmF":{"name":"itemPreview","abstract":"

    Item was previewd

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO10itemUploadyA2EmF":{"name":"itemUpload","abstract":"

    Item was uploaded

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11itemCommentyA2EmF":{"name":"itemComment","abstract":"

    Item was commented on

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO8itemOpenyA2EmF":{"name":"itemOpen","abstract":"

    Item was opened

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO10itemModifyyA2EmF":{"name":"itemModify","abstract":"

    Item was modified

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK10RecentItemC15InteractionTypeO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"InteractionType"},"Classes/RecentItem/InteractionType.html":{"name":"InteractionType","abstract":"

    Interaction type with item

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC15interactionTypeAC011InteractionF0Ovp":{"name":"interactionType","abstract":"

    Type of interation

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC12interactedAt10Foundation4DateVvp":{"name":"interactedAt","abstract":"

    Timestamp of the interactions

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4itemAA4FileCvp":{"name":"item","abstract":"

    The item

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC21interactionSharedLinkSSSgvp":{"name":"interactionSharedLink","abstract":"

    Shared link of interaction

    ","parent_name":"RecentItem"},"Classes/RecentItem.html#/s:6BoxSDK10RecentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"RecentItem"},"Classes/PollingURLInfo.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC3url10Foundation3URLVvp":{"name":"url","abstract":"

    URL value for checking for new events.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC16timeoutInSecondsSivp":{"name":"timeoutInSeconds","abstract":"

    Timeout in seconds after which request for new changes should be repeated.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC10maxRetriesSSvp":{"name":"maxRetries","abstract":"

    Maximum number of retries in case of failed request for new changes.

    ","parent_name":"PollingURLInfo"},"Classes/PollingURLInfo.html#/s:6BoxSDK14PollingURLInfoC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PollingURLInfo"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7rawDataSDySSypGvp":{"name":"rawData","abstract":"

    Box item type

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7versionSivp":{"name":"version","abstract":"

    Version

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC7messageAA21EventObserverResponseOvp":{"name":"message","abstract":"

    Message specifying type of the response.

    ","parent_name":"PollingResult"},"Classes/PollingResult.html#/s:6BoxSDK13PollingResultC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PollingResult"},"Classes/PathCollection.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of entries in a path

    ","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC7entriesSayAA6FolderCGSgvp":{"name":"entries","abstract":"

    Entries (folders) in a path to an item

    ","parent_name":"PathCollection"},"Classes/PathCollection.html#/s:6BoxSDK14PathCollectionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"PathCollection"},"Classes/MetadataTemplate.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC2idSSSgvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC11templateKeySSSgvp":{"name":"templateKey","abstract":"

    A unique identifier for the template. The identifier must be unique across the scope of the enterprise to which the metadata template is being applied.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC5scopeSSSgvp":{"name":"scope","abstract":"

    The scope of the object. Global and enterprise scopes are supported.","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC11displayNameSSSgvp":{"name":"displayName","abstract":"

    The display name of the template.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC6hiddenSbSgvp":{"name":"hidden","abstract":"

    Whether this template is hidden in the UI.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC22copyInstanceOnItemCopySbSgvp":{"name":"copyInstanceOnItemCopy","abstract":"

    Whether or not to copy any metadata attached to a file or folder when it is copied. By default, metadata is not copied along with a file or folder when it is copied.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC6fieldsSayAA0C5FieldVGSgvp":{"name":"fields","abstract":"

    The ordered set of key:value pairs for the template.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataTemplate.html#/s:6BoxSDK16MetadataTemplateC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataTemplate"},"Classes/MetadataObject.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC2idSSSgvp":{"name":"id","abstract":"

    Identifier.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC8templateSSSgvp":{"name":"template","abstract":"

    The key of the template.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC5scopeSSSgvp":{"name":"scope","abstract":"

    The scope of the object. global and enterprise scopes are supported. The global scope contains the properties template,","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC6parentSSSgvp":{"name":"parent","abstract":"

    The ID of the object the metadata object belongs to. Both file and folder objects are supported.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC7versionSiSgvp":{"name":"version","abstract":"

    The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4typeSSSgvp":{"name":"type","abstract":"

    A unique identifier for the “type” of this instance.

    ","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC11typeVersionSiSgvp":{"name":"typeVersion","abstract":"

    The last-known version of the template of the object.","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4keysSDySSypGvp":{"name":"keys","abstract":"

    Custom value(s) defined by the template. These values also have a corresponding display name","parent_name":"MetadataObject"},"Classes/MetadataObject.html#/s:6BoxSDK14MetadataObjectC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataObject"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC4typeSSvp":{"name":"type","abstract":"

    Object type.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC2idSSvp":{"name":"id","abstract":"

    Identifier.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC15ownerEnterpriseAA0G0CSgvp":{"name":"ownerEnterprise","abstract":"

    The enterprise that owns the policy.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    Represent the parent of the policy and the metadata instance to cascade down.

    ","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC5scopeAA0C5ScopeOSgvp":{"name":"scope","abstract":"

    The scope of the target instance that will be cascaded down. The scope & templateKey together identify","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC11templateKeySSSgvp":{"name":"templateKey","abstract":"

    The template key of the target metadata template to cascade down. The scope & templateKey together identify","parent_name":"MetadataCascadePolicy"},"Classes/MetadataCascadePolicy.html#/s:6BoxSDK21MetadataCascadePolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"MetadataCascadePolicy"},"Classes/Lock.html#/s:6BoxSDK4LockC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    Who created the lock.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When was lock created.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When lock expires.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC19isDownloadPreventedSbSgvp":{"name":"isDownloadPrevented","abstract":"

    Whether or not the file can be downloaded while locked.

    ","parent_name":"Lock"},"Classes/Lock.html#/s:6BoxSDK4LockC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Lock"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    FIle type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO11fileVersionyAeA04FileJ0CcAEmF":{"name":"fileVersion(_:)","abstract":"

    File version type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC0fG4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"AssignmentItemType"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem/AssignmentItemType.html":{"name":"AssignmentItemType","abstract":"

    Type of item legal hold policy was assigned to

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC9itemValueAC0fG4TypeOvp":{"name":"itemValue","abstract":"

    Item that the legal hold policy is assigned to

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignmentItem.html#/s:6BoxSDK29LegalHoldPolicyAssignmentItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicyAssignmentItem"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC05legaldE0AA0cdE0CSgvp":{"name":"legalHoldPolicy","abstract":"

    The policy that the legal hold policy assignment is part of.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedToAA0cdeF4ItemCSgvp":{"name":"assignedTo","abstract":"

    The entity that the legal hold policy assignment is assigned to.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedByAA4UserCSgvp":{"name":"assignedBy","abstract":"

    The user who created the legal hold policy assignment.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC10assignedAt10Foundation4DateVSgvp":{"name":"assignedAt","abstract":"

    When the legal hold policy assignment object was created.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    When the assignment release request was sent.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicyAssignment.html#/s:6BoxSDK25LegalHoldPolicyAssignmentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicyAssignment"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO6activeyA2EmF":{"name":"active","abstract":"

    The policy is not in a transition state

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO8applyingyA2EmF":{"name":"applying","abstract":"

    That the policy is in the process of being applied

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO9releasingyA2EmF":{"name":"releasing","abstract":"

    That the process is in the process of being released

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO8releasedyA2EmF":{"name":"released","abstract":"

    The policy is no longer active

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK15LegalHoldPolicyC6StatusO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value for enum values not yet implemented in the SDK

    ","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"Status"},"Classes/LegalHoldPolicy/Status.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"Status"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV4userSivp":{"name":"user","abstract":"

    Number of assigned users

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV6folderSivp":{"name":"folder","abstract":"

    Number of assigned folders

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV4fileSivp":{"name":"file","abstract":"

    Number of assigned files

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html#/s:6BoxSDK15LegalHoldPolicyC16AssignmentCountsV11fileVersionSivp":{"name":"fileVersion","abstract":"

    Number of assigned file verions

    ","parent_name":"AssignmentCounts"},"Classes/LegalHoldPolicy/AssignmentCounts.html":{"name":"AssignmentCounts","abstract":"

    Counts of the assignments to different entities of this policy

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy/Status.html":{"name":"Status","abstract":"

    Status of legal hold policy

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC10policyNameSSSgvp":{"name":"policyName","abstract":"

    Name of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC11descriptionSSSgvp":{"name":"description","abstract":"

    Description of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC6statusAC6StatusOSgvp":{"name":"status","abstract":"

    Status of the legal hold policy.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC16assignmentCountsAC010AssignmentG0VSgvp":{"name":"assignmentCounts","abstract":"

    Counts of assignments within this policy by apply-to type.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the legal hold policy object.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the legal hold policy object was created.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the legal hold policy object was modified.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    When the policy release request was sent.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC15filterStartedAt10Foundation4DateVSgvp":{"name":"filterStartedAt","abstract":"

    User-specified, optional date filter applies to Custodian assignments only.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC13filterEndedAt10Foundation4DateVSgvp":{"name":"filterEndedAt","abstract":"

    User-specified, optional date filter applies to Custodian assignments only.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC12releaseNotesSSSgvp":{"name":"releaseNotes","abstract":"

    Notes about why the policy was released.

    ","parent_name":"LegalHoldPolicy"},"Classes/LegalHoldPolicy.html#/s:6BoxSDK15LegalHoldPolicyC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"LegalHoldPolicy"},"Classes/Invite.html#/s:6BoxSDK6InviteC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9invitedToAA10EnterpriseCSgvp":{"name":"invitedTo","abstract":"

    Enterprise object user is invited to.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC12actionableByAA4UserCSgvp":{"name":"actionableBy","abstract":"

    The user who was invited to the enterprise

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9invitedByAA4UserCSgvp":{"name":"invitedBy","abstract":"

    User who created the invitation.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC6statusSSSgvp":{"name":"status","abstract":"

    Invitation status

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When invitation was created.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When invitation was updated.

    ","parent_name":"Invite"},"Classes/Invite.html#/s:6BoxSDK6InviteC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Invite"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV13canRunReportsSbvp":{"name":"canRunReports","abstract":"

    Group can run reports

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV15canInstantLoginSbvp":{"name":"canInstantLogin","abstract":"

    Group can login instantly

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV17canCreateAccountsSbvp":{"name":"canCreateAccounts","abstract":"

    Group can create accounts

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html#/s:6BoxSDK15GroupMembershipC23ConfigurablePermissionsV15canEditAccountsSbvp":{"name":"canEditAccounts","abstract":"

    Group can edit accounts

    ","parent_name":"ConfigurablePermissions"},"Classes/GroupMembership/ConfigurablePermissions.html":{"name":"ConfigurablePermissions","abstract":"

    Permissions of group membership

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC2idSSvp":{"name":"id","abstract":"

    The ID of the association between a user and a group.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4userAA4UserCSgvp":{"name":"user","abstract":"

    A user object associated with the group.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC5groupAA0C0CSgvp":{"name":"group","abstract":"

    The group the user is associated with.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4roleAA0C4RoleOSgvp":{"name":"role","abstract":"

    The role of the user within the group. The default is member with an option for admin.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC23configurablePermissionsAC012ConfigurableF0VSgvp":{"name":"configurablePermissions","abstract":"

    Permissions of an individual group member.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The date time this membership was created at.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The date time this membership was modified at.

    ","parent_name":"GroupMembership"},"Classes/GroupMembership.html#/s:6BoxSDK15GroupMembershipC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"GroupMembership"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO07managedC0yA2EmF":{"name":"managedGroup","abstract":"

    Group is managed by the Enterprise admin

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO08allUsersC0yA2EmF":{"name":"allUsersGroup","abstract":"

    A Box-defined group that includes all users in an Enterprise

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK5GroupC0C4TypeO11customValueyAESScAEmF":{"name":"customValue(_:)","abstract":"

    Custom value not yet implemented in this SDK.

    ","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:6BoxSDK0A4EnumPyxSScfc":{"name":"init(_:)","parent_name":"GroupType"},"Classes/Group/GroupType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"GroupType"},"Classes/Group/GroupType.html":{"name":"GroupType","abstract":"

    The type of the group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC2idSSvp":{"name":"id","abstract":"

    The ID of the group object.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4nameSSSgvp":{"name":"name","abstract":"

    The name of the group

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC9groupTypeAC0cE0OSgvp":{"name":"groupType","abstract":"

    The type of the group

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the group object was created.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the group object was last modified.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC10provenanceSSSgvp":{"name":"provenance","abstract":"

    Keeps track of which external source this group is coming.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC11descriptionSSSgvp":{"name":"description","abstract":"

    Human readable description of the group. This can be up to 255 characters long

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC22externalSyncIdentifierSSSgvp":{"name":"externalSyncIdentifier","abstract":"

    An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC17invitabilityLevelAA0c12InvitabilityE0OSgvp":{"name":"invitabilityLevel","abstract":"

    Specifies who can invite the group to collaborate on folders.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC22memberViewabilityLevelAA0c6MembereF0OSgvp":{"name":"memberViewabilityLevel","abstract":"

    Specifies who can view the members of the group.

    ","parent_name":"Group"},"Classes/Group.html#/s:6BoxSDK5GroupC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Group"},"Classes/FolderUploadEmail.html#/s:6BoxSDK17FolderUploadEmailC6accessSSSgvp":{"name":"access","abstract":"

    Access level

    ","parent_name":"FolderUploadEmail"},"Classes/FolderUploadEmail.html#/s:6BoxSDK17FolderUploadEmailC5emailSSSgvp":{"name":"email","abstract":"

    Email addresss

    ","parent_name":"FolderUploadEmail"},"Classes/FolderLock/LockedOperations.html#/s:6BoxSDK10FolderLockC16LockedOperationsV6deleteSbSgvp":{"name":"delete","abstract":"

    Whether deleting the folder is restricted.

    ","parent_name":"LockedOperations"},"Classes/FolderLock/LockedOperations.html#/s:6BoxSDK10FolderLockC16LockedOperationsV4moveSbSgvp":{"name":"move","abstract":"

    Whether moving the folder is restricted.

    ","parent_name":"LockedOperations"},"Classes/FolderLock/LockedOperations.html":{"name":"LockedOperations","abstract":"

    Locked operations on the folder

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user or group that created the lock.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the folder lock object was created.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC6folderAA0C0CSgvp":{"name":"folder","abstract":"

    The (mini) folder object that the lock applies to.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC8lockTypeSSSgvp":{"name":"lockType","abstract":"

    The lock type, value is always “freeze”.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC16lockedOperationsAC06LockedF0VSgvp":{"name":"lockedOperations","abstract":"

    The operations that have been locked.

    ","parent_name":"FolderLock"},"Classes/FolderLock.html#/s:6BoxSDK10FolderLockC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FolderLock"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Download permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canUploadSbSgvp":{"name":"canUpload","abstract":"

    Upload permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Rename permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Delete permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Share permission

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV21canInviteCollaboratorSbSgvp":{"name":"canInviteCollaborator","abstract":"

    Permission to add collaborators

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html#/s:6BoxSDK6FolderC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Permission to set shared link access level for the folder

    ","parent_name":"Permissions"},"Classes/Folder/Permissions.html":{"name":"Permissions","abstract":"

    An object containing the permissions that the current user has on this file.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this folder. Used with If-Match headers.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4nameSSSgvp":{"name":"name","abstract":"

    The name of the folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time the folder was created.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this folder was last updated on the Box servers.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the folder. The limit is 256 characters.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC37isCollaborationRestrictedToEnterpriseSbSgvp":{"name":"isCollaborationRestrictedToEnterprise","abstract":"

    Whether future collaborations should be restricted to within the enterprise only

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4sizeSiSgvp":{"name":"size","abstract":"

    The folder size in bytes.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC14pathCollectionAA04PathE0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this folder, starting at the root.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last modified this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10sharedLinkAA06SharedE0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this file. Is nil if no shared link has been created.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17folderUploadEmailAA0ceF0CSgvp":{"name":"folderUploadEmail","abstract":"

    The upload email address for this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC6parentACSgvp":{"name":"parent","abstract":"

    The folder that contains this folder. May be nil for folders such as root, trash and child folders whose parent is inaccessible.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC10itemStatusAA04ItemE0OSgvp":{"name":"itemStatus","abstract":"

    Whether this item is deleted or not.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC16contentCreatedAt10Foundation4DateVSgvp":{"name":"contentCreatedAt","abstract":"

    The time the folder or its contents were originally created (according to the uploader). May be nil for some folders such as root or trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17contentModifiedAt10Foundation4DateVSgvp":{"name":"contentModifiedAt","abstract":"

    The time the folder or its contents were last modified (according to the uploader). May be nil for some folders such as root or trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC18canNonOwnersInviteSbSgvp":{"name":"canNonOwnersInvite","abstract":"

    Whether non-owners can invite collaborators to this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    The time the folder or its contents were put in the trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    The time the folder or its contents will be purged from the trash.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC9syncStateAA04SyncE0OSgvp":{"name":"syncState","abstract":"

    Whether this folder will be synced by the Box sync clients or not.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17hasCollaborationsSbSgvp":{"name":"hasCollaborations","abstract":"

    Whether this folder has any collaborators.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    An object containing the permissions that the current user has on this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4tagsSaySSGSgvp":{"name":"tags","abstract":"

    All tags applied to this folder.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC29allowedSharedLinkAccessLevelsSayAA0efG0OGSgvp":{"name":"allowedSharedLinkAccessLevels","abstract":"

    Access level settings for shared links set by administrator.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC19allowedInviteeRolesSaySSGSgvp":{"name":"allowedInviteeRoles","abstract":"

    Folder collaboration roles allowed by the enterprise administrator.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC17isExternallyOwnedSbSgvp":{"name":"isExternallyOwned","abstract":"

    Whether this folder is owned by a user outside of the enterprise.

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC11collectionsSaySDyS2SGGSgvp":{"name":"collections","abstract":"

    The collections the folder belongs to

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC14classificationAA14ClassificationCSgvp":{"name":"classification","abstract":"

    Details about the classification applied to a Box folder

    ","parent_name":"Folder"},"Classes/Folder.html#/s:6BoxSDK6FolderC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Folder"},"Classes/FileVersionRetention.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC04fileD0AA0cD0CSgvp":{"name":"fileVersion","abstract":"

    The file version this file version retention was applied to.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4fileAA0C0CSgvp":{"name":"file","abstract":"

    The file this file version retention was applied to.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC9appliedAt10Foundation4DateVSgvp":{"name":"appliedAt","abstract":"

    When this file version retention object was created.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC13dispositionAt10Foundation4DateVSgvp":{"name":"dispositionAt","abstract":"

    When the retention period expires on this file version retention.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC07winningE6PolicyAA0eG0CSgvp":{"name":"winningRetentionPolicy","abstract":"

    The winning retention policy applied to this file version retention. A file version can have multiple retention policies applied.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionRetention.html#/s:6BoxSDK20FileVersionRetentionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersionRetention"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC2idSSvp":{"name":"id","abstract":"

    The ID of the file version legal hold object.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC04fileD0AA0cD0CSgvp":{"name":"fileVersion","abstract":"

    The file version that is held

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4fileAA0C0CSgvp":{"name":"file","abstract":"

    The parent file of the file version that is held.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC05legalF17PolicyAssignmentsSayAA0efH10AssignmentCGSgvp":{"name":"legalHoldPolicyAssignments","abstract":"

    List of assignments contributing to this hold.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC9deletedAt10Foundation4DateVSgvp":{"name":"deletedAt","abstract":"

    Time that this file version legal hold was deleted.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersionLegalHold.html#/s:6BoxSDK20FileVersionLegalHoldC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersionLegalHold"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC2idSSvp":{"name":"id","abstract":"

    The ID of the file version object

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4sha1SSSgvp":{"name":"sha1","abstract":"

    The SHA-1 hash of the file.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4nameSSSgvp":{"name":"name","abstract":"

    The name of the file version

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4sizes5Int64VSgvp":{"name":"size","abstract":"

    Size of the file version in bytes

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC19uploaderDisplayNameSSSgvp":{"name":"uploaderDisplayName","abstract":"

    User’s name at the time of upload

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the file version object was created

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the file version object was last updated

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last updated the file version

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When the file version object was trashed.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC9trashedByAA4UserCSgvp":{"name":"trashedBy","abstract":"

    The user who trashed the file version.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When the file version object was purged.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10restoredAt10Foundation4DateVSgvp":{"name":"restoredAt","abstract":"

    When the file version object was restored.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC10restoredByAA4UserCSgvp":{"name":"restoredBy","abstract":"

    The user who restored the file version.

    ","parent_name":"FileVersion"},"Classes/FileVersion.html#/s:6BoxSDK11FileVersionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"FileVersion"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV11canDownloadSbSgvp":{"name":"canDownload","abstract":"

    Permission for download

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV10canPreviewSbSgvp":{"name":"canPreview","abstract":"

    Permission for preview

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canUploadSbSgvp":{"name":"canUpload","abstract":"

    Permission for upload

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV10canCommentSbSgvp":{"name":"canComment","abstract":"

    Permission to comment

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canRenameSbSgvp":{"name":"canRename","abstract":"

    Permission to rename

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV9canDeleteSbSgvp":{"name":"canDelete","abstract":"

    Permission to delete

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV8canShareSbSgvp":{"name":"canShare","abstract":"

    Permission to share

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV17canSetShareAccessSbSgvp":{"name":"canSetShareAccess","abstract":"

    Permission to share access

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV21canInviteCollaboratorSbSgvp":{"name":"canInviteCollaborator","abstract":"

    Permission to invite collaborators

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV11canAnnotateSbSgvp":{"name":"canAnnotate","abstract":"

    Permission to annotate

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV21canViewAnnotationsAllSbSgvp":{"name":"canViewAnnotationsAll","abstract":"

    Permission to view all annotations

    ","parent_name":"Permissions"},"Classes/File/Permissions.html#/s:6BoxSDK4FileC11PermissionsV22canViewAnnotationsSelfSbSgvp":{"name":"canViewAnnotationsSelf","abstract":"

    Permission to view signed in user annotations

    ","parent_name":"Permissions"},"Classes/File/Permissions.html":{"name":"Permissions","abstract":"

    Permissions that the current user has on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11fileVersionAA0cE0CSgvp":{"name":"fileVersion","abstract":"

    The version information of the file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10sequenceIdSSSgvp":{"name":"sequenceId","abstract":"

    A unique ID for use with the events.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4etagSSSgvp":{"name":"etag","abstract":"

    The entity tag of this file object.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4sha1SSSgvp":{"name":"sha1","abstract":"

    The SHA-1 hash of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4nameSSSgvp":{"name":"name","abstract":"

    The name of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9extensionSSSgvp":{"name":"extension","abstract":"

    Indicates the suffix, when available, on the file. By default, set to an empty string.","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11descriptionSSSgvp":{"name":"description","abstract":"

    The description of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4sizeSiSgvp":{"name":"size","abstract":"

    Size of this file in bytes.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC14pathCollectionAA04PathE0CSgvp":{"name":"pathCollection","abstract":"

    The path of folders to this item, starting at the root.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC12commentCountSiSgvp":{"name":"commentCount","abstract":"

    Description

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The number of comments on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When this file was last updated on the Box servers.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9trashedAt10Foundation4DateVSgvp":{"name":"trashedAt","abstract":"

    When this file was moved to the trash.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC8purgedAt10Foundation4DateVSgvp":{"name":"purgedAt","abstract":"

    When this file will be permanently deleted.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC16contentCreatedAt10Foundation4DateVSgvp":{"name":"contentCreatedAt","abstract":"

    When the content of this file was created.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17contentModifiedAt10Foundation4DateVSgvp":{"name":"contentModifiedAt","abstract":"

    When the content of this file was last modified.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9isPackageSbSgvp":{"name":"isPackage","abstract":"

    Whether the file is a package. Used for Mac Packages used by iWorks.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC19uploaderDisplayNameSSSgvp":{"name":"uploaderDisplayName","abstract":"

    User’s name at the time of upload

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who first created this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10modifiedByAA4UserCSgvp":{"name":"modifiedBy","abstract":"

    The user who last updated this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user who owns this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10sharedLinkAA06SharedE0CSgvp":{"name":"sharedLink","abstract":"

    The shared link object for this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC6parentAA6FolderCSgvp":{"name":"parent","abstract":"

    The folder containing this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC10itemStatusAA04ItemE0OSgvp":{"name":"itemStatus","abstract":"

    Whether this item is deleted or not. Values include active, trashed if the file has been moved to the trash,","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC13versionNumberSSSgvp":{"name":"versionNumber","abstract":"

    The version number of this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When the file will automatically be deleted, i.e. expired.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11permissionsAC11PermissionsVSgvp":{"name":"permissions","abstract":"

    Permissions that the current user has on this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17expiringEmbedLinkAA08ExpiringeF0CSgvp":{"name":"expiringEmbedLink","abstract":"

    An expiring URL for an embedded preview session in an iframe. This URL will expire after 60 seconds and the session will expire after 60 minutes.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC11collectionsSaySDyS2SGGSgvp":{"name":"collections","abstract":"

    The collections that the file belongs to

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4lockAA4LockCSgvp":{"name":"lock","abstract":"

    The lock held on this file. If there is no lock, this can either be null or have a timestamp in the past.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4tagsSaySSGSgvp":{"name":"tags","abstract":"

    All tags applied to this file

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17hasCollaborationsSbSgvp":{"name":"hasCollaborations","abstract":"

    Whether this file has any collaborators.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC17isExternallyOwnedSbSgvp":{"name":"isExternallyOwned","abstract":"

    Whether this file is owned by a user outside of the enterprise.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC19allowedInviteeRolesSayAA17CollaborationRoleOGSgvp":{"name":"allowedInviteeRoles","abstract":"

    File collaboration roles allowed by the enterprise administrator.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC15representationsAA24EntryContainerInnerModelCyAA0C14RepresentationVGSgvp":{"name":"representations","abstract":"

    Digital assets created for this file.

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC14classificationAA14ClassificationCSgvp":{"name":"classification","abstract":"

    Details about the classification applied to a Box file

    ","parent_name":"File"},"Classes/File.html#/s:6BoxSDK4FileC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"File"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC3url10Foundation3URLVSgvp":{"name":"url","abstract":"

    Embed link URL

    ","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC5tokenAA5TokenCSgvp":{"name":"token","abstract":"

    Information about the token used by the embed component

    ","parent_name":"ExpiringEmbedLink"},"Classes/ExpiringEmbedLink.html#/s:6BoxSDK17ExpiringEmbedLinkC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"ExpiringEmbedLink"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO6folderyAeA6FolderCcAEmF":{"name":"folder(_:)","abstract":"

    Folder type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO4fileyAeA4FileCcAEmF":{"name":"file(_:)","abstract":"

    File type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO7commentyAeA7CommentCcAEmF":{"name":"comment(_:)","abstract":"

    Comment type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"EventItemType"},"Classes/EventItem/EventItemType.html#/s:6BoxSDK9EventItemC0cD4TypeO7unknownyA2EmF":{"name":"unknown","abstract":"

    Unknown type

    ","parent_name":"EventItemType"},"Classes/EventItem.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EventItem"},"Classes/EventItem/EventItemType.html":{"name":"EventItemType","abstract":"

    Type of the object modified by the event

    ","parent_name":"EventItem"},"Classes/EventItem.html#/s:6BoxSDK9EventItemC9itemValueAC0cD4TypeOvp":{"name":"itemValue","abstract":"

    Event item type

    ","parent_name":"EventItem"},"Classes/EventItem.html#/s:6BoxSDK9EventItemC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EventItem"},"Classes/EventContainer.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of events

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC7entriesSayAA0C0CGSgvp":{"name":"entries","abstract":"

    Events in a container

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC5limitSiSgvp":{"name":"limit","abstract":"

    Maximum number of events per page

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC18nextStreamPositionSSSgvp":{"name":"nextStreamPosition","abstract":"

    Defines next stream position in the stream

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC9chunkSizeSiSgvp":{"name":"chunkSize","abstract":"

    The number of event records contained in the object with entries.

    ","parent_name":"EventContainer"},"Classes/EventContainer.html#/s:6BoxSDK14EventContainerC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EventContainer"},"Classes/Event.html#/s:6BoxSDK5EventC4typeSSvp":{"name":"type","abstract":"

    Box event object type

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user that performed the action represented by the event. Some events may be performed by users not logged into Box.","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9eventTypeAA0cE0Ovp":{"name":"eventType","abstract":"

    One of the event types.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9sessionIdSSSgvp":{"name":"sessionId","abstract":"

    The session ID of the user who performed the action represented by the event.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC6sourceAA0C4ItemCSgvp":{"name":"source","abstract":"

    The object associated with the event.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the event occurred (when the user performed the action).

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC10recordedAt10Foundation4DateVSgvp":{"name":"recordedAt","abstract":"

    When the event was stored in the Box database.

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC17additionalDetailsSDySSypGSgvp":{"name":"additionalDetails","abstract":"

    Additional details for the event

    ","parent_name":"Event"},"Classes/Event.html#/s:6BoxSDK5EventC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Event"},"Classes/EntryContainerInnerModel.html#/s:6BoxSDK24EntryContainerInnerModelC7entriesSayxGSgvp":{"name":"entries","abstract":"

    Container entries

    ","parent_name":"EntryContainerInnerModel"},"Classes/Order.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC2bySSSgvp":{"name":"by","abstract":"

    Defines which parameters are items ordered by

    ","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC9directionAA0C9DirectionOSgvp":{"name":"direction","abstract":"

    Defines direction of items order - ascending or descending

    ","parent_name":"Order"},"Classes/Order.html#/s:6BoxSDK5OrderC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Order"},"Classes/EntryContainer.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    Number of entries

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC7entriesSayxGvp":{"name":"entries","abstract":"

    Entries in a container

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC6offsetSiSgvp":{"name":"offset","abstract":"

    Paging offset

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC10nextMarkerSSSgvp":{"name":"nextMarker","abstract":"

    Next paging marker value

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC18nextStreamPositionSSSgvp":{"name":"nextStreamPosition","abstract":"

    Next stream position

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC5limitSiSgvp":{"name":"limit","abstract":"

    Maximum number of items per page

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC5orderSayAA5OrderCGSgvp":{"name":"order","abstract":"

    Defines how entries are ordered

    ","parent_name":"EntryContainer"},"Classes/EntryContainer.html#/s:6BoxSDK14EntryContainerC4jsonACyxGSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EntryContainer"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4typeSSvp":{"name":"type","abstract":"

    Type of Box item.

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4nameSSSgvp":{"name":"name","abstract":"

    Enterprise name

    ","parent_name":"Enterprise"},"Classes/Enterprise.html#/s:6BoxSDK10EnterpriseC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Enterprise"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC4typeSSvp":{"name":"type","abstract":"

    Type of Box item.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC11isConfirmedSbSgvp":{"name":"isConfirmed","abstract":"

    Whether email alias is confirmed.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC5emailSSSgvp":{"name":"email","abstract":"

    User’s email address.

    ","parent_name":"EmailAlias"},"Classes/EmailAlias.html#/s:6BoxSDK10EmailAliasC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"EmailAlias"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC2idSSvp":{"name":"id","abstract":"

    The ID of the device pinner object.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC7ownedByAA4UserCSgvp":{"name":"ownedBy","abstract":"

    The user that the device pin belongs to.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC11productNameSSSgvp":{"name":"productName","abstract":"

    The type of device being pinned.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time the device pin was created.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time the device pin was modified.

    ","parent_name":"DevicePin"},"Classes/DevicePin.html#/s:6BoxSDK9DevicePinC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"DevicePin"},"Classes/Comment.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC07isReplyC0SbSgvp":{"name":"isReplyComment","abstract":"

    Whether or not this comment is a reply to another comment.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC7messageSSSgvp":{"name":"message","abstract":"

    The comment text that the user typed.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC13taggedMessageSSSgvp":{"name":"taggedMessage","abstract":"

    The string representing the comment text with @mentions included. @mention format is @[id:username]","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    A mini user object representing the author of the comment.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    The time this comment was created.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The object this comment was placed on.

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    The time this comment was last modified

    ","parent_name":"Comment"},"Classes/Comment.html#/s:6BoxSDK7CommentC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Comment"},"Classes/Collaborator/CollaboratorType.html#/s:6BoxSDK12CollaboratorC0C4TypeO4useryAeA4UserCcAEmF":{"name":"user(_:)","abstract":"

    User type

    ","parent_name":"CollaboratorType"},"Classes/Collaborator/CollaboratorType.html#/s:6BoxSDK12CollaboratorC0C4TypeO5groupyAeA5GroupCcAEmF":{"name":"group(_:)","abstract":"

    Group type

    ","parent_name":"CollaboratorType"},"Classes/Collaborator.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Collaborator"},"Classes/Collaborator/CollaboratorType.html":{"name":"CollaboratorType","abstract":"

    Type of collaborator

    ","parent_name":"Collaborator"},"Classes/Collaborator.html#/s:6BoxSDK12CollaboratorC17collaboratorValueAC0C4TypeOvp":{"name":"collaboratorValue","abstract":"

    Type of collaborator

    ","parent_name":"Collaborator"},"Classes/Collaborator.html#/s:6BoxSDK12CollaboratorC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Collaborator"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4userAA4UserCSgvp":{"name":"user","abstract":"

    The user that is exempted from the collaboration allowlist

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the enterprise.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the target object was created.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the target object was last modified.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistExemptTarget.html#/s:6BoxSDK34CollaborationAllowlistExemptTargetC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationAllowlistExemptTarget"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC6domainSSSgvp":{"name":"domain","abstract":"

    The URL domain name

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC9directionAA0C9DirectionOSgvp":{"name":"direction","abstract":"

    Direction of colaboration - can be inbound, outbound or both

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC10enterpriseAA10EnterpriseCSgvp":{"name":"enterprise","abstract":"

    Mini representation of the user’s enterprise.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the collaboration object was created.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the collaboration object was last modified.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/CollaborationAllowlistEntry.html#/s:6BoxSDK27CollaborationAllowlistEntryC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"CollaborationAllowlistEntry"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC013enterpriseHasdE11AuthEnabledSbvp":{"name":"enterpriseHasTwoFactorAuthEnabled","abstract":"

    Indicator for whether the enterpise has two factor authentication enabled.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC07userHasdeF7EnabledSbvp":{"name":"userHasTwoFactorAuthenticationEnabled","abstract":"

    Indicator for whether the user has two factor authentication enabled.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html#/s:6BoxSDK13CollaborationC34TwoFactorAuthenticationRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TwoFactorAuthenticationRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC06strongE24RequiredForExternalUsersSbvp":{"name":"strongPasswordRequiredForExternalUsers","abstract":"

    Indicator for whether the current enterprise has strong password enabled for users external","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC07userHasdE0Sbvp":{"name":"userHasStrongPassword","abstract":"

    Indicator for whether the user has strong password enabled.

    ","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/StrongPasswordRequirement.html#/s:6BoxSDK13CollaborationC25StrongPasswordRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"StrongPasswordRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC10isAcceptedSbvp":{"name":"isAccepted","abstract":"

    Indicator for whether or not the Terms of Service has been accepted.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC05termseF0AA0deF0Cvp":{"name":"termsOfService","abstract":"

    The Terms of Service associated with the requirement status.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/TermsOfServiceRequirement.html#/s:6BoxSDK13CollaborationC25TermsOfServiceRequirementC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"TermsOfServiceRequirement"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC25termsOfServiceRequirementAC05TermshiJ0Cvp":{"name":"termsOfServiceRequirement","abstract":"

    The requirements for Terms of Service part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC25strongPasswordRequirementAC06StronghI0Cvp":{"name":"strongPasswordRequirement","abstract":"

    The requirements for Strong Password part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC34twoFactorAuthenticationRequirementAC03TwohiJ0Cvp":{"name":"twoFactorAuthenticationRequirement","abstract":"

    The requirements for Two Factor Authentication part of Acceptance Requirements Status object.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration/AcceptanceRequirementsStatus.html#/s:6BoxSDK13CollaborationC28AcceptanceRequirementsStatusC4jsonAESDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"AcceptanceRequirementsStatus"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4typeSSvp":{"name":"type","abstract":"

    Box item type

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9createdByAA4UserCSgvp":{"name":"createdBy","abstract":"

    The user who created the collaboration object.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9createdAt10Foundation4DateVSgvp":{"name":"createdAt","abstract":"

    When the collaboration object was created.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC10modifiedAt10Foundation4DateVSgvp":{"name":"modifiedAt","abstract":"

    When the collaboration object was last modified.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC9expiresAt10Foundation4DateVSgvp":{"name":"expiresAt","abstract":"

    When the collaboration will expire.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC6statusAA0C6StatusOSgvp":{"name":"status","abstract":"

    The status of the collaboration invitation.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC12accessibleByAA12CollaboratorCSgvp":{"name":"accessibleBy","abstract":"

    The user or group that is granted access.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4roleAA0C4RoleOSgvp":{"name":"role","abstract":"

    The level of access granted.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC14acknowledgedAt10Foundation4DateVSgvp":{"name":"acknowledgedAt","abstract":"

    When the status of the collaboration object changed to accepted or rejected.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4itemAA0C4ItemOSgvp":{"name":"item","abstract":"

    The file or folder that access is granted to

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC11inviteEmailSSSgvp":{"name":"inviteEmail","abstract":"

    The email address used to invite an un-registered collaborator, if they are not a registered user.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC11canViewPathSbSgvp":{"name":"canViewPath","abstract":"

    Whether the “view path collaboration” feature is enabled or not.","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC28acceptanceRequirementsStatusAC010AcceptanceeF0CSgvp":{"name":"acceptanceRequirementsStatus","abstract":"

    The acceptance requirements for the user or enterprise.

    ","parent_name":"Collaboration"},"Classes/Collaboration.html#/s:6BoxSDK13CollaborationC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Collaboration"},"Classes/Collaboration/AcceptanceRequirementsStatus.html":{"name":"AcceptanceRequirementsStatus","abstract":"

    Defines the Acceptance Requirements Status object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/TermsOfServiceRequirement.html":{"name":"TermsOfServiceRequirement","abstract":"

    Defines the Terms of Service requirement for the Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/StrongPasswordRequirement.html":{"name":"StrongPasswordRequirement","abstract":"

    Defines the Strong Password requirement for the Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Collaboration/TwoFactorAuthenticationRequirement.html":{"name":"TwoFactorAuthenticationRequirement","abstract":"

    Defines the Two Factor Authentication Requirement for Acceptance Requirements object.

    ","parent_name":"Collaboration"},"Classes/Classification.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC5colorSo7UIColorCSgvp":{"name":"color","abstract":"

    The color that is used to display the classification label in a user-interface

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC10definitionSSSgvp":{"name":"definition","abstract":"

    An explanation of the meaning of this classification

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC4nameSSSgvp":{"name":"name","abstract":"

    Name of the classification

    ","parent_name":"Classification"},"Classes/Classification.html#/s:6BoxSDK14ClassificationC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"Classification"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4typeSSvp":{"name":"type","abstract":"

    Box item type - should be collection.

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC2idSSvp":{"name":"id","abstract":"

    Identifier

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4nameSSSgvp":{"name":"name","abstract":"

    Name of the collection

    ","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC14collectionTypeSSSgvp":{"name":"collectionType","abstract":"

    The type of the collection. This is used to determine the proper visual treatment for collections.","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A5ModelP7rawDataSDySSypGvp":{"name":"rawData","parent_name":"BoxCollection"},"Classes/BoxCollection.html#/s:6BoxSDK0A10CollectionC4jsonACSDySSypG_tKcfc":{"name":"init(json:)","abstract":"

    Initializer.

    ","parent_name":"BoxCollection"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO10jsonObjectyAESDySSypGcAEmF":{"name":"jsonObject(_:)","abstract":"

    JSON body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO9jsonArrayyAESaySDySSypGGcAEmF":{"name":"jsonArray(_:)","abstract":"

    JSON Array body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO14urlencodedFormyAESDyS2SGcAEmF":{"name":"urlencodedForm(_:)","abstract":"

    URL encoded form body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO4datayAE10Foundation4DataVcAEmF":{"name":"data(_:)","abstract":"

    Data body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO9multipartyAeA13MultipartFormVcAEmF":{"name":"multipart(_:)","abstract":"

    Multipart form body type

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html#/s:6BoxSDK0A7RequestC8BodyTypeO5emptyyA2EmF":{"name":"empty","abstract":"

    Empty body

    ","parent_name":"BodyType"},"Classes/BoxRequest/BodyType.html":{"name":"BodyType","abstract":"

    Defines body type of a request

    ","parent_name":"BoxRequest"},"Classes/PagingIterator.html#/s:6BoxSDK14PagingIteratorC10totalCountSiSgvp":{"name":"totalCount","abstract":"

    The total count of the result set, if known

    ","parent_name":"PagingIterator"},"Classes/PagingIterator.html#/s:6BoxSDK14PagingIteratorC4next10completionyys6ResultOyAA14EntryContainerCyxGAA0A8SDKErrorCGc_tF":{"name":"next(completion:)","abstract":"

    Gets next page of elements from the iterator

    ","parent_name":"PagingIterator"},"Classes/BoxNetworkTask.html#/s:6BoxSDK0A11NetworkTaskC9cancelledSbvp":{"name":"cancelled","abstract":"

    Whether the task is cancelled or not

    ","parent_name":"BoxNetworkTask"},"Classes/BoxNetworkTask.html#/s:6BoxSDK0A11NetworkTaskC6cancelyyF":{"name":"cancel()","abstract":"

    Method to cancel a Box Network Task

    ","parent_name":"BoxNetworkTask"},"Classes/BoxNetworkAgent.html#/s:6BoxSDK0A12NetworkAgentC13configurationAcA0A16SDKConfigurationV_tcfc":{"name":"init(configuration:)","abstract":"

    Initializer.

    ","parent_name":"BoxNetworkAgent"},"Classes/BoxNetworkAgent.html#/s:6BoxSDK0A12NetworkAgentC4send7request10completionyAA0A7RequestC_ys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"send(request:completion:)","abstract":"

    Makes Box SDK request

    ","parent_name":"BoxNetworkAgent"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC4list6marker5limit6fieldsAA14PagingIteratorCyAA7WebhookCGSSSg_SiSgSaySSGSgtF":{"name":"list(marker:limit:fields:)","abstract":"

    Get all webhooks in an enterprise.

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC3get9webhookId6fields10completionySS_SaySSGSgys6ResultOyAA7WebhookCAA0A8SDKErrorCGctF":{"name":"get(webhookId:fields:completion:)","abstract":"

    Get information about a webhook.

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6update9webhookId10targetType0hG08triggers7address6fields10completionySS_SSSgALSayAA7WebhookC13EventTriggersOGSgALSaySSGSgys6ResultOyAnA0A8SDKErrorCGctF":{"name":"update(webhookId:targetType:targetId:triggers:address:fields:completion:)","abstract":"

    Update a webhook

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6create10targetType0F2Id8triggers7address6fields10completionySS_SSSayAA7WebhookC13EventTriggersOGSSSaySSGSgys6ResultOyAlA0A8SDKErrorCGctF":{"name":"create(targetType:targetId:triggers:address:fields:completion:)","abstract":"

    Create a webhook

    ","parent_name":"WebhooksModule"},"Classes/WebhooksModule.html#/s:6BoxSDK14WebhooksModuleC6delete9webhookId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(webhookId:completion:)","abstract":"

    Deletes a webhook.

    ","parent_name":"WebhooksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC3get9webLinkId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(webLinkId:fields:completion:)","abstract":"

    Get information about a specified web link.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6create3url8parentId4name11description10sharedLink6fields10completionySS_S2SSgAlA17NullableParameterOyAA06SharedM4DataVGSgSaySSGSgys6ResultOyAA0cM0CAA0A8SDKErrorCGctF":{"name":"create(url:parentId:name:description:sharedLink:fields:completion:)","abstract":"

    Creates a new web link with the specified url on the specified item.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6update9webLinkId3url06parentI04name11description06sharedH06fields10completionySS_SSSgA3mA17NullableParameterOyAA06SharedH4DataVGSgSaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"update(webLinkId:url:parentId:name:description:sharedLink:fields:completion:)","abstract":"

    Update the specified web link info.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC6delete9webLinkId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(webLinkId:completion:)","abstract":"

    Delete a specified web link.

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC13getSharedLink03forcH010completionySS_ys6ResultOyAA0gH0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forWebLink:completion:)","abstract":"

    Gets web link with updated shared link

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC13setSharedLink03forcH06access10unsharedAt8password11canDownload10completionySS_AA0gH6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0gH0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forWebLink:access:unsharedAt:password:canDownload:completion:)","abstract":"

    Creates or updates shared link for a web link

    ","parent_name":"WebLinksModule"},"Classes/WebLinksModule.html#/s:6BoxSDK14WebLinksModuleC16deleteSharedLink03forcH010completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forWebLink:completion:)","abstract":"

    Removes shared link for a web link

    ","parent_name":"WebLinksModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC10getCurrent6fields10completionySaySSGSg_ys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"getCurrent(fields:completion:)","abstract":"

    Get information about the user for which this client is authenticated.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC3get6userId6fields10completionySS_SaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"get(userId:fields:completion:)","abstract":"

    Get information about a user in the enterprise. Requires enterprise administration","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC9getAvatar6userId10completionySS_ys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF":{"name":"getAvatar(userId:completion:)","abstract":"

    Get image of a user’s avatar

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6create5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0J24ExternalCollabRestricted0J22ExemptFromDeviceLimits0J27ExemptFromLoginVerification6status6fields10completionySS_SSAA8UserRoleOSgSSSgSbSgA3Zs5Int64VSgSayAA4UserC12TrackingCodeVGSgA_AZA_A_A_AA10UserStatusOSgSaySSGSgys6ResultOyA4_AA0A8SDKErrorCGctF":{"name":"create(login:name:role:language:isSyncEnabled:jobTitle:phone:address:spaceAmount:trackingCodes:canSeeManagedUsers:timezone:isExternalCollabRestricted:isExemptFromDeviceLimits:isExemptFromLoginVerification:status:fields:completion:)","abstract":"

    Create a new managed user in an enterprise. This method only works for Box admins.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6update6userId5login4name4role8language13isSyncEnabled8jobTitle5phone7address11spaceAmount13trackingCodes013canSeeManagedC08timezone0L24ExternalCollabRestricted0L22ExemptFromDeviceLimits0L27ExemptFromLoginVerification6status6fields10completionySS_SSSgAxA8UserRoleOSgAXSbSgA3Xs5Int64VSgSayAA4UserC12TrackingCodeVGSgA0_AXA0_A0_A0_AA10UserStatusOSgSaySSGSgys6ResultOyA5_AA0A8SDKErrorCGctF":{"name":"update(userId:login:name:role:language:isSyncEnabled:jobTitle:phone:address:spaceAmount:trackingCodes:canSeeManagedUsers:timezone:isExternalCollabRestricted:isExemptFromDeviceLimits:isExemptFromLoginVerification:status:fields:completion:)","abstract":"

    Update the information for a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC13createAppUser4name8language8jobTitle8timezone5phone7address11spaceAmount6status26isExternalCollabRestricted013canSeeManagedC06fields10completionySS_SSSgA4Qs5Int64VSgAA0G6StatusOSgSbSgAXSaySSGSgys6ResultOyAA0G0CAA0A8SDKErrorCGctF":{"name":"createAppUser(name:language:jobTitle:timezone:phone:address:spaceAmount:status:isExternalCollabRestricted:canSeeManagedUsers:fields:completion:)","abstract":"

    Create a new app user in an enterprise.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC6delete6userId6notify5force10completionySS_SbSgAIys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(userId:notify:force:completion:)","abstract":"

    Delete a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC17listForEnterprise10filterTerm6fields9usemarker6marker6offset5limitAA14PagingIteratorCyAA4UserCGSSSg_SaySSGSgSbSgAPSiSgATtF":{"name":"listForEnterprise(filterTerm:fields:usemarker:marker:offset:limit:)","abstract":"

    Returns all of the users for the Enterprise. Only available to admin accounts or service accounts.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC22inviteToJoinEnterprise5login12enterpriseId6fields10completionySS_SSSaySSGSgys6ResultOyAA6InviteCAA0A8SDKErrorCGctF":{"name":"inviteToJoinEnterprise(login:enterpriseId:fields:completion:)","abstract":"

    Invite an existing user to join an Enterprise.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC20moveItemsOwnedByUser6withID02toi4WithK06notify6fields10completionySS_SSSbSgSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"moveItemsOwnedByUser(withID:toUserWithID:notify:fields:completion:)","abstract":"

    Move all of the items owned by a user into a new folder in another user’s account.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC11changeLogin6userId5login6fields10completionySS_SSSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"changeLogin(userId:login:fields:completion:)","abstract":"

    Used to convert one of the user’s confirmed email aliases into the user’s primary login.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16listEmailAliases6userId10completionySS_ys6ResultOyAA14EntryContainerCyAA0F5AliasCGAA0A8SDKErrorCGctF":{"name":"listEmailAliases(userId:completion:)","abstract":"

    Retrieves all email aliases for this user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16createEmailAlias6userId5email10completionySS_SSys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createEmailAlias(userId:email:completion:)","abstract":"

    Adds a new email alias to the given user’s account.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC16deleteEmailAlias6userId05emailgI010completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteEmailAlias(userId:emailAliasId:completion:)","abstract":"

    Removes an email alias from a user.

    ","parent_name":"UsersModule"},"Classes/UsersModule.html#/s:6BoxSDK11UsersModuleC19rollOutOfEnterprise6userId6notify6fields10completionySS_SbSgSaySSGSgys6ResultOyAA4UserCAA0A8SDKErrorCGctF":{"name":"rollOutOfEnterprise(userId:notify:fields:completion:)","abstract":"

    Roll a user out of their enterprise (and convert them to a standalone free user)

    ","parent_name":"UsersModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC9listItems6offset5limit6fieldsAA14PagingIteratorCyAA10FolderItemOGSiSg_AMSaySSGSgtF":{"name":"listItems(offset:limit:fields:)","abstract":"

    Gets the files, folders and web links that are in the user’s trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC7getFile2id6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getFile(id:fields:completion:)","abstract":"

    Get a file that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC9getFolder2id6fields10completionySS_SaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getFolder(id:fields:completion:)","abstract":"

    Get a folder that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC10getWebLink2id6fields10completionySS_SaySSGSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getWebLink(id:fields:completion:)","abstract":"

    Get a web link that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC11restoreFile2id4name14parentFolderId6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"restoreFile(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a file that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC13restoreFolder2id4name06parentF2Id6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"restoreFolder(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a folder that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC14restoreWebLink2id4name14parentFolderId6fields10completionySS_SSSgAJSaySSGSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"restoreWebLink(id:name:parentFolderId:fields:completion:)","abstract":"

    Restores a web link that has been moved to the trash.

    ","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC21permanentlyDeleteFile2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteFile(id:completion:)","abstract":"

    Permanently delete a file that is in the trash. The file will no longer exist in Box.","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC23permanentlyDeleteFolder2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteFolder(id:completion:)","abstract":"

    Permanently delete a folder that is in the trash. The folder will no longer exist","parent_name":"TrashModule"},"Classes/TrashModule.html#/s:6BoxSDK11TrashModuleC24permanentlyDeleteWebLink2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"permanentlyDeleteWebLink(id:completion:)","abstract":"

    Permanently delete a web link that is in the trash. The web link will no longer exist","parent_name":"TrashModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6create6status7tosType4text6fields10completionyAA0cD13ServiceStatusO_AA0cdnJ0OSSSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF":{"name":"create(status:tosType:text:fields:completion:)","abstract":"

    Creates a Terms of Service for an enterprise.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC6update5tosId4text6status6fields10completionySS_SSAA0cD13ServiceStatusOSaySSGSgys6ResultOyAA0cdN0CAA0A8SDKErrorCGctF":{"name":"update(tosId:text:status:fields:completion:)","abstract":"

    Updates a specified Terms of Service.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC3get5tosId6fields10completionySS_SaySSGSgys6ResultOyAA0cD7ServiceCAA0A8SDKErrorCGctF":{"name":"get(tosId:fields:completion:)","abstract":"

    Retrieves a specified Terms of Service.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC17listForEnterprise7tosType6fields10completionyAA0cd7ServiceK0OSg_SaySSGSgys6ResultOySayAA0cdN0CGAA0A8SDKErrorCGctF":{"name":"listForEnterprise(tosType:fields:completion:)","abstract":"

    Retrieves both external and managed Terms of Services if no Terms of Service type is specified.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16createUserStatus5tosId10isAccepted04userK06fields10completionySS_SbSSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"createUserStatus(tosId:isAccepted:userId:fields:completion:)","abstract":"

    Creates an association between a terms of service and a specified user. If no user is specified, defaults to current user.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC16updateUserStatus04userI2Id10isAccepted6fields10completionySS_SbSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"updateUserStatus(userStatusId:isAccepted:fields:completion:)","abstract":"

    Update the user status on the Terms of Service. Choose to either accept or deny.

    ","parent_name":"TermsOfServicesModule"},"Classes/TermsOfServicesModule.html#/s:6BoxSDK21TermsOfServicesModuleC13getUserStatus5tosId04userK06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0cd7ServicehI0CAA0A8SDKErrorCGctF":{"name":"getUserStatus(tosId:userId:fields:completion:)","abstract":"

    Retrieves the user status for the specified Terms of Service and the specified user.

    ","parent_name":"TermsOfServicesModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC3get6taskId6fields10completionySS_SaySSGSgys6ResultOyAA4TaskCAA0A8SDKErrorCGctF":{"name":"get(taskId:fields:completion:)","abstract":"

    Fetches a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6create6fileId6action7message5dueAt14completionRule6fields0L0ySS_AA10TaskActionOSSSg10Foundation4DateVSgAA0o10CompletionM0OSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"create(fileId:action:message:dueAt:completionRule:fields:completion:)","abstract":"

    Used to create a single task for single user on a single file.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6update6taskId6action7message5dueAt14completionRule6fields0L0ySS_AA10TaskActionOSSSg10Foundation4DateVSgAA0o10CompletionM0OSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"update(taskId:action:message:dueAt:completionRule:fields:completion:)","abstract":"

    Updates a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6delete6taskId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(taskId:completion:)","abstract":"

    Permanently deletes a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC13getAssignment04taskF2Id6fields10completionySS_SaySSGSgys6ResultOyAA04TaskF0CAA0A8SDKErrorCGctF":{"name":"getAssignment(taskAssignmentId:fields:completion:)","abstract":"

    Fetches a specific task assignment.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC6assign6taskId04userG06fields10completionySS_SSSaySSGSgys6ResultOyAA14TaskAssignmentCAA0A8SDKErrorCGctF":{"name":"assign(taskId:userId:fields:completion:)","abstract":"

    Used to assign a task to a single user identified by userId.","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC13assignByEmail6taskId5email6fields10completionySS_SSSaySSGSgys6ResultOyAA14TaskAssignmentCAA0A8SDKErrorCGctF":{"name":"assignByEmail(taskId:email:fields:completion:)","abstract":"

    Used to assign a task to a single user identified by login.","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC16updateAssignment04taskF2Id7message15resolutionState10completionySS_SSSgAA0fK0OSgys6ResultOyAA04TaskF0CAA0A8SDKErrorCGctF":{"name":"updateAssignment(taskAssignmentId:message:resolutionState:completion:)","abstract":"

    Used to update a task assignment.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC16deleteAssignment04taskF2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteAssignment(taskAssignmentId:completion:)","abstract":"

    Permanently deletes a specific task.

    ","parent_name":"TasksModule"},"Classes/TasksModule.html#/s:6BoxSDK11TasksModuleC15listAssignments9forTaskId10completionySS_ys6ResultOySayAA0H10AssignmentCGAA0A8SDKErrorCGctF":{"name":"listAssignments(forTaskId:completion:)","abstract":"

    Fetches a all task assignments for particular task.

    ","parent_name":"TasksModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC3get15storagePolicyId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(storagePolicyId:fields:completion:)","abstract":"

    Get information about a storage policy.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC17listForEnterprise6marker5limit6fieldsAA14PagingIteratorCyAA0C6PolicyCGSSSg_SiSgSaySSGSgtF":{"name":"listForEnterprise(marker:limit:fields:)","abstract":"

    Get all of the storage policies in an enterprise.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC13getAssignment013storagePolicyG2Id6fields10completionySS_SaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF":{"name":"getAssignment(storagePolicyAssignmentId:fields:completion:)","abstract":"

    Get storage policy assignment information.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC15listAssignments15resolvedForType0hI2Id6fields10completionySS_SSSaySSGSgys6ResultOyAA0C16PolicyAssignmentCAA0A8SDKErrorCGctF":{"name":"listAssignments(resolvedForType:resolvedForId:fields:completion:)","abstract":"

    Get the storage policy assignment assigned to a user or enterprise.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC6assign15storagePolicyId14assignedToType0jkI06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cH10AssignmentCAA0A8SDKErrorCGctF":{"name":"assign(storagePolicyId:assignedToType:assignedToId:fields:completion:)","abstract":"

    Create storage policy assignment.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC11forceAssign15storagePolicyId14assignedToType0klJ06fields10completionySS_S2SSaySSGSgys6ResultOyAA0cI10AssignmentCAA0A8SDKErrorCGctF":{"name":"forceAssign(storagePolicyId:assignedToType:assignedToId:fields:completion:)","abstract":"

    Assign policy

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16updateAssignment013storagePolicyG2Id0hiJ06fields10completionySS_SSSgSaySSGSgys6ResultOyAA0ciG0CAA0A8SDKErrorCGctF":{"name":"updateAssignment(storagePolicyAssignmentId:storagePolicyId:fields:completion:)","abstract":"

    Update storage policy assignment.

    ","parent_name":"StoragePoliciesModule"},"Classes/StoragePoliciesModule.html#/s:6BoxSDK21StoragePoliciesModuleC16deleteAssignment013storagePolicyG2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteAssignment(storagePolicyAssignmentId:completion:)","abstract":"

    Deleting a storage policy assignment means the user will inherit the Enterprise’s default storage policy.

    ","parent_name":"StoragePoliciesModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC6create7signers11sourceFiles12parentFolder10parameters10completionySayAA0C19RequestCreateSignerVG_SayAA0cnO10SourceFileVGAA0cno6ParentK0VAA0cnO10ParametersVSgys6ResultOyAA0cN0CAA0A8SDKErrorCGctF":{"name":"create(signers:sourceFiles:parentFolder:parameters:completion:)","abstract":"

    Creates a sign request. This involves preparing a document for signing and sending the sign request to signers.

    ","parent_name":"SignRequestsModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC4list6marker5limitAA14PagingIteratorCyAA0C7RequestCGSSSg_SiSgtF":{"name":"list(marker:limit:)","abstract":"

    List all sign requests.

    ","parent_name":"SignRequestsModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC7getById2id10completionySS_ys6ResultOyAA0C7RequestCAA0A8SDKErrorCGctF":{"name":"getById(id:completion:)","abstract":"

    Get sign request by ID.

    ","parent_name":"SignRequestsModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC10resendById2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"resendById(id:completion:)","abstract":"

    Resends a sign request email to all outstanding signers.","parent_name":"SignRequestsModule"},"Classes/SignRequestsModule.html#/s:6BoxSDK18SignRequestsModuleC10cancelById2id10completionySS_ys6ResultOyAA0C7RequestCAA0A8SDKErrorCGctF":{"name":"cancelById(id:completion:)","abstract":"

    Cancels a sign request if it has not yet been signed or declined.","parent_name":"SignRequestsModule"},"Classes/SharedItemsModule.html#/s:6BoxSDK17SharedItemsModuleC3get13sharedLinkURL0gH8Password6fields10completionySS_SSSgSaySSGSgys6ResultOyAA0C4ItemCAA0A8SDKErrorCGctF":{"name":"get(sharedLinkURL:sharedLinkPassword:fields:completion:)","abstract":"

    Get the item back from the shared link.

    ","parent_name":"SharedItemsModule"},"Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC5queryAD5scope14fileExtensions12createdAfter0I6Before07updatedJ00lK011sizeAtLeast0mN4Most12ownerUserIDs014ancestorFolderS08searchIn8itemType0V5Trash14metadataFilter6fields6offset5limitAA14PagingIteratorCyAA0U4ItemOGSSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA8_A8_A8_s5Int64VSgA11_A4_A4_SayAA0c7ContentY0OGSgAA0c4ItemY0OSgSbSgAA08MetadataC6FilterCSgA4_SiSgA23_tF":{"name":"query(query:scope:fileExtensions:createdAfter:createdBefore:updatedAfter:updatedBefore:sizeAtLeast:sizeAtMost:ownerUserIDs:ancestorFolderIDs:searchIn:itemType:searchTrash:metadataFilter:fields:offset:limit:)","abstract":"

    Searches for items in Box.

    ","parent_name":"SearchModule"},"Classes/SearchModule.html#/s:6BoxSDK12SearchModuleC20queryWithSharedLinks0E05scope14fileExtensions12createdAfter0L6Before07updatedM00oN011sizeAtLeast0pQ4Most12ownerUserIDs014ancestorFolderV08searchIn8itemType0Y5Trash14metadataFilter6fields6offset5limitAA14PagingIteratorCyAA0C6ResultCGSSSg_AA0C5ScopeOSgSaySSGSg10Foundation4DateVSgA9_A9_A9_s5Int64VSgA12_A5_A5_SayAA0C11ContentTypeOGSgAA0C8ItemTypeOSgSbSgAA08MetadataC6FilterCSgA5_SiSgA24_tF":{"name":"queryWithSharedLinks(query:scope:fileExtensions:createdAfter:createdBefore:updatedAfter:updatedBefore:sizeAtLeast:sizeAtMost:ownerUserIDs:ancestorFolderIDs:searchIn:itemType:searchTrash:metadataFilter:fields:offset:limit:)","abstract":"

    Searches for items in Box, including items that a user might have accessed recently through a shared link.

    ","parent_name":"SearchModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC3get8policyId10completionySS_ys6ResultOyAA0C6PolicyCAA0A8SDKErrorCGctF":{"name":"get(policyId:completion:)","abstract":"

    Retrieves information about a retention policy

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6create4name4type6length17dispositionAction014canOwnerExtendC017areOwnersNotified28customNotificationRecipients10completionySS_AA0C10PolicyTypeOSiSgAA011DispositionK0OSbSgARSayAA4UserCGSgys6ResultOyAA0cV0CAA0A8SDKErrorCGctF":{"name":"create(name:type:length:dispositionAction:canOwnerExtendRetention:areOwnersNotified:customNotificationRecipients:completion:)","abstract":"

    Creates a new retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6update8policyId4name17dispositionAction6status10completionySS_SSSgAA011DispositionK0OSgAA0C12PolicyStatusOSgys6ResultOyAA0cO0CAA0A8SDKErrorCGctF":{"name":"update(policyId:name:dispositionAction:status:completion:)","abstract":"

    Updates existing retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC4list4name4type15createdByUserId6marker5limitAA14PagingIteratorCyAA0C11PolicyEntryCGSSSg_AA0cQ4TypeOSgA2OSiSgtF":{"name":"list(name:type:createdByUserId:marker:limit:)","abstract":"

    Retrieves all of the retention policies for the given enterprise.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC13getAssignment12assignmentId10completionySS_ys6ResultOyAA0c6PolicyG0CAA0A8SDKErrorCGctF":{"name":"getAssignment(assignmentId:completion:)","abstract":"

    Retrieves information about a retention policy assignment.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC6assign8policyId015assignedContentH00fJ4Type12filterFields10completionySS_SSAA0c20PolicyAssignmentItemK0OSayAA19MetadataFieldFilterVGSgys6ResultOyAA0coP0CAA0A8SDKErrorCGctF":{"name":"assign(policyId:assignedContentId:assignContentType:filterFields:completion:)","abstract":"

    Creates new retention policy assignment to a content.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RetentionPoliciesModule.html#/s:6BoxSDK23RetentionPoliciesModuleC15listAssignments8policyId4type6marker5limitAA14PagingIteratorCyAA0C16PolicyAssignmentCGSS_AA0cO4TypeOSgSSSgSiSgtF":{"name":"listAssignments(policyId:type:marker:limit:)","abstract":"

    Returns a list of all retention policy assignments associated with a specified retention policy.

    ","parent_name":"RetentionPoliciesModule"},"Classes/RecentItemsModule.html#/s:6BoxSDK17RecentItemsModuleC4list6marker5limit6fieldsAA14PagingIteratorCyAA0C4ItemCGSSSg_SiSgSaySSGSgtF":{"name":"list(marker:limit:fields:)","abstract":"

    Get recent items.

    ","parent_name":"RecentItemsModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list9forFileId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF":{"name":"list(forFileId:completion:)","abstract":"

    Retrieve all metadata associated with a given file

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"get(forFileWithId:scope:templateKey:completion:)","abstract":"

    Get the metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create13forFileWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"create(forFileWithId:scope:templateKey:keys:completion:)","abstract":"

    Create a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update13forFileWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"update(forFileWithId:scope:templateKey:operations:completion:)","abstract":"

    Update a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete13forFileWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(forFileWithId:scope:templateKey:completion:)","abstract":"

    Delete a metadata instance for a file.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC4list11forFolderId10completionySS_ys6ResultOySayAA0C6ObjectCGAA0A8SDKErrorCGctF":{"name":"list(forFolderId:completion:)","abstract":"

    Retrieve all metadata associated with a given folder

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC3get15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"get(forFolderWithId:scope:templateKey:completion:)","abstract":"

    Get the metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6create15forFolderWithId5scope11templateKey4keys10completionySS_S2SSDySSypGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"create(forFolderWithId:scope:templateKey:keys:completion:)","abstract":"

    Create a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6update15forFolderWithId5scope11templateKey10operations10completionySS_S2SSayAA0gC9OperationOGys6ResultOyAA0C6ObjectCAA0A8SDKErrorCGctF":{"name":"update(forFolderWithId:scope:templateKey:operations:completion:)","abstract":"

    Update a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC6delete15forFolderWithId5scope11templateKey10completionySS_S2Sys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(forFolderWithId:scope:templateKey:completion:)","abstract":"

    Delete a metadata instance for a folder.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC16getTemplateByKey5scope08templateH010completionySS_SSys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"getTemplateByKey(scope:templateKey:completion:)","abstract":"

    Get metadata template by name (templateKey).

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC15getTemplateById2id10completionySS_ys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"getTemplateById(id:completion:)","abstract":"

    Get metadata template by ID.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14createTemplate5scope11templateKey11displayName6hidden22copyInstanceOnItemCopy6fields10completionySS_S2SS2bSgSayAA0C5FieldVGys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"createTemplate(scope:templateKey:displayName:hidden:copyInstanceOnItemCopy:fields:completion:)","abstract":"

    Create metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14updateTemplate5scope11templateKey9operation10completionySS_SSAA0cF9OperationOys6ResultOyAA0cF0CAA0A8SDKErrorCGctF":{"name":"updateTemplate(scope:templateKey:operation:completion:)","abstract":"

    Update metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC14deleteTemplate5scope11templateKey10completionySS_SSys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteTemplate(scope:templateKey:completion:)","abstract":"

    Delete metadata template.

    ","parent_name":"MetadataModule"},"Classes/MetadataModule.html#/s:6BoxSDK14MetadataModuleC23listEnterpriseTemplates5scope6marker5limitAA14PagingIteratorCyAA0C8TemplateCGSS_SSSgSiSgtF":{"name":"listEnterpriseTemplates(scope:marker:limit:)","abstract":"

    Retrieve all metadata templates within the specified enterprise

    ","parent_name":"MetadataModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC4list8folderId015ownerEnterpriseI06fields6marker5limitAA14PagingIteratorCyAA0cdE0CGSS_SSSgSaySSGSgAOSiSgtF":{"name":"list(folderId:ownerEnterpriseId:fields:marker:limit:)","abstract":"

    Retrieve an iterator for available metadata cascade policies within a given folder for the current enterprise.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC3get2id6fields10completionySS_SaySSGSgys6ResultOyAA0cdE0CAA0A8SDKErrorCGctF":{"name":"get(id:fields:completion:)","abstract":"

    Get information about a specific metadata cascade policy.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC6create8folderId5scope11templateKey6fields10completionySS_AA0C5ScopeOSSSaySSGSgys6ResultOyAA0cdE0CAA0A8SDKErrorCGctF":{"name":"create(folderId:scope:templateKey:fields:completion:)","abstract":"

    Create a metadata cascade policy that applies to a given folder and a metadata instance attached to the given folder.","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC6delete2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(id:completion:)","abstract":"

    Delete a metadata cascade policy that applies to a given folder and a folder-attached instance of given template.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/MetadataCascadePolicyModule.html#/s:6BoxSDK27MetadataCascadePolicyModuleC10forceApply2id18conflictResolution10completionySS_AA08ConflictK0Oys6ResultOyytAA0A8SDKErrorCGctF":{"name":"forceApply(id:conflictResolution:completion:)","abstract":"

    If a policy already exists on a folder, this will apply that policy to all existing files and sub-folders within the target folder.

    ","parent_name":"MetadataCascadePolicyModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC3get8policyId6fields10completionySS_SaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"get(policyId:fields:completion:)","abstract":"

    Get information about a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6create10policyName11description15filterStartedAt0j5EndedL09isOngoing6fields10completionySS_SSSg10Foundation4DateVSgAPSbSgSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"create(policyName:description:filterStartedAt:filterEndedAt:isOngoing:fields:completion:)","abstract":"

    Create a new legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6update8policyId0G4Name11description12releaseNotes6fields10completionySS_SSSgA2KSaySSGSgys6ResultOyAA0C10HoldPolicyCAA0A8SDKErrorCGctF":{"name":"update(policyId:policyName:description:releaseNotes:fields:completion:)","abstract":"

    Update a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC6delete8policyId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(policyId:completion:)","abstract":"

    Deletes a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC17listForEnterprise10policyName6marker5limit6fieldsAA14PagingIteratorCyAA0C10HoldPolicyCGSSSg_ANSiSgSaySSGSgtF":{"name":"listForEnterprise(policyName:marker:limit:fields:)","abstract":"

    Get all of the legal hold policies for the enterprise.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC19getPolicyAssignment12assignmentId6fields10completionySS_SaySSGSgys6ResultOyAA0c4HoldgH0CAA0A8SDKErrorCGctF":{"name":"getPolicyAssignment(assignmentId:fields:completion:)","abstract":"

    Get information about a policy assignmnet.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC12assignPolicy8policyId0f2ToI00fJ4Type6fields10completionySS_S2SSaySSGSgys6ResultOyAA0c4HoldG10AssignmentCAA0A8SDKErrorCGctF":{"name":"assignPolicy(policyId:assignToId:assignToType:fields:completion:)","abstract":"

    Assign a legal hold to a file, file version, folder, or user.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC22deletePolicyAssignment12assignmentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deletePolicyAssignment(assignmentId:completion:)","abstract":"

    Sends a request to delete an existing policy assignment.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC21listPolicyAssignments8policyId12assignToType0klJ06marker5limit6fieldsAA14PagingIteratorCyAA0c4HoldG10AssignmentCGSS_SSSgA2PSiSgSaySSGSgtF":{"name":"listPolicyAssignments(policyId:assignToType:assignToId:marker:limit:fields:)","abstract":"

    Get all of the assignments for a legal hold policy.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC20getFileVersionPolicy11legalHoldId6fields10completionySS_SaySSGSgys6ResultOyAA0ghcK0CAA0A8SDKErrorCGctF":{"name":"getFileVersionPolicy(legalHoldId:fields:completion:)","abstract":"

    Get information about a file version legal hold.

    ","parent_name":"LegalHoldsModule"},"Classes/LegalHoldsModule.html#/s:6BoxSDK16LegalHoldsModuleC23listFileVersionPolicies8policyId6marker5limit6fieldsAA14PagingIteratorCyAA0ghC4HoldCGSS_SSSgSiSgSaySSGSgtF":{"name":"listFileVersionPolicies(policyId:marker:limit:fields:)","abstract":"

    Get all of the non-deleted legal holds for a single legal hold policy

    ","parent_name":"LegalHoldsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC3get7groupId6fields10completionySS_SaySSGSgys6ResultOyAA5GroupCAA0A8SDKErrorCGctF":{"name":"get(groupId:fields:completion:)","abstract":"

    Retrieves a specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6create4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityM06fields10completionySS_SSSgA2mA017GroupInvitabilityM0OSgAA0r6MemberoM0OSgSaySSGSgys6ResultOyAA0R0CAA0A8SDKErrorCGctF":{"name":"create(name:provenance:externalSyncIdentifier:description:invitabilityLevel:memberViewabilityLevel:fields:completion:)","abstract":"

    Creates a new Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6update7groupId4name10provenance22externalSyncIdentifier11description17invitabilityLevel017memberViewabilityO06fields10completionySS_SSSgAA17NullableParameterOySSGSgA2rA017GroupInvitabilityO0OSgAA0v6MemberqO0OSgSaySSGSgys6ResultOyAA0V0CAA0A8SDKErrorCGctF":{"name":"update(groupId:name:provenance:externalSyncIdentifier:description:invitabilityLevel:memberViewabilityLevel:fields:completion:)","abstract":"

    Updates the specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC6delete7groupId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(groupId:completion:)","abstract":"

    Deletes the specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17listForEnterprise4name6offset5limit6fieldsAA14PagingIteratorCyAA5GroupCGSSSg_SiSgAOSaySSGSgtF":{"name":"listForEnterprise(name:offset:limit:fields:)","abstract":"

    Get all Groups for an enterprise.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC17getMembershipInfo12membershipId6fields10completionySS_SaySSGSgys6ResultOyAA05GroupF0CAA0A8SDKErrorCGctF":{"name":"getMembershipInfo(membershipId:fields:completion:)","abstract":"

    Retrieves a specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16createMembership6userId05groupH04role22configurablePermission6fields10completionySS_SSAA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableL4DataVGSgSaySSGSgys6ResultOyAA0oF0CAA0A8SDKErrorCGctF":{"name":"createMembership(userId:groupId:role:configurablePermission:fields:completion:)","abstract":"

    Creates a Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16updateMembership12membershipId4role22configurablePermission6fields10completionySS_AA9GroupRoleOSgAA17NullableParameterOyAA012ConfigurableK4DataVGSgSaySSGSgys6ResultOyAA0nF0CAA0A8SDKErrorCGctF":{"name":"updateMembership(membershipId:role:configurablePermission:fields:completion:)","abstract":"

    Updates the specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC16deleteMembership12membershipId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteMembership(membershipId:completion:)","abstract":"

    Deletes the specified Group Membership.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC15listMemberships7groupId6offset5limit6fieldsAA14PagingIteratorCyAA15GroupMembershipCGSS_SiSgANSaySSGSgtF":{"name":"listMemberships(groupId:offset:limit:fields:)","abstract":"

    Get all Memberships for a specified Group.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC22listMembershipsForUser6userId6offset5limit6fieldsAA14PagingIteratorCyAA15GroupMembershipCGSS_SiSgANSaySSGSgtF":{"name":"listMembershipsForUser(userId:offset:limit:fields:)","abstract":"

    Returns all of the group memberships for a given user. Note this is only available to group admins.

    ","parent_name":"GroupsModule"},"Classes/GroupsModule.html#/s:6BoxSDK12GroupsModuleC18listCollaborations7groupId6offset5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SiSgANSaySSGSgtF":{"name":"listCollaborations(groupId:offset:limit:fields:)","abstract":"

    Returns all of the group collaborations for a given group. Note this is only available to group admins.

    ","parent_name":"GroupsModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC3get8folderId6fields10completionySS_SaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"get(folderId:fields:completion:)","abstract":"

    Get information about a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listItems8folderId9usemarker6marker6offset5limit4sort9direction6fieldsAA14PagingIteratorCyAA10FolderItemOGSS_SbSgSSSgSiSgAtA0rF7OrderByOSgAA0T9DirectionOSgSaySSGSgtF":{"name":"listItems(folderId:usemarker:marker:offset:limit:sort:direction:fields:)","abstract":"

    Gets all of the files, folders, or web links contained within a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6create4name8parentId6fields10completionySS_SSSaySSGSgys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"create(name:parentId:fields:completion:)","abstract":"

    Create a new folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6update8folderId4name11description06parentG010sharedLink0F17UploadEmailAccess4tags18canNonOwnersInvite37isCollaborationRestrictedToEnterprise11collections6fields10completionySS_SSSgA2qA17NullableParameterOyAA06SharedL4DataVGSgAA06FoldermnO0OSgSaySSGSgSbSgA1_A0_A0_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"update(folderId:name:description:parentId:sharedLink:folderUploadEmailAccess:tags:canNonOwnersInvite:isCollaborationRestrictedToEnterprise:collections:fields:completion:)","abstract":"

    Update a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC6delete8folderId9recursive10completionySS_SbSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(folderId:recursive:completion:)","abstract":"

    Delete a folder or move a folder to the trash. The recursive parameter must be included in","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC4copy8folderId19destinationFolderID4name6fields10completionySS_S2SSgSaySSGSgys6ResultOyAA0I0CAA0A8SDKErrorCGctF":{"name":"copy(folderId:destinationFolderID:name:fields:completion:)","abstract":"

    Used to create a copy of a folder in another folder. The original version of the folder will not be altered.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC18listCollaborations8folderId6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SaySSGSgtF":{"name":"listCollaborations(folderId:fields:)","abstract":"

    Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14addToFavorites8folderId10completionySS_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"addToFavorites(folderId:completion:)","abstract":"

    Add folder to favorites

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC15addToCollection8folderId010collectionI010completionySS_SSys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"addToCollection(folderId:collectionId:completion:)","abstract":"

    Add folder to particular collection

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC19removeFromFavorites8folderId10completionySS_ys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"removeFromFavorites(folderId:completion:)","abstract":"

    Remove folder from favorites

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC20removeFromCollection8folderId010collectionI010completionySS_SSys6ResultOyAA6FolderCAA0A8SDKErrorCGctF":{"name":"removeFromCollection(folderId:collectionId:completion:)","abstract":"

    Add folder to particular collection

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13getSharedLink9forFolder10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forFolder:completion:)","abstract":"

    Gets folder with updated shared link

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC13setSharedLink9forFolder6access10unsharedAt8password11canDownload10completionySS_AA0fG6AccessOSgAA17NullableParameterOy10Foundation4DateVGSgAOySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forFolder:access:unsharedAt:password:canDownload:completion:)","abstract":"

    Creates or updates shared link for a folder

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC16deleteSharedLink9forFolder10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forFolder:completion:)","abstract":"

    Removes shared link for a folder

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC12getWatermark8folderId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getWatermark(folderId:completion:)","abstract":"

    Retrieves the watermark on a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC14applyWatermark8folderId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"applyWatermark(folderId:completion:)","abstract":"

    Apply or update the watermark on a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC15removeWatermark8folderId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"removeWatermark(folderId:completion:)","abstract":"

    Remove the watermark from a specified folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC9listLocks8folderIdAA14PagingIteratorCyAA10FolderLockCGSS_tF":{"name":"listLocks(folderId:)","abstract":"

    Get all of the locks on a folder.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10createLock8folderId10completionySS_ys6ResultOyAA06FolderF0CAA0A8SDKErrorCGctF":{"name":"createLock(folderId:completion:)","abstract":"

    Creates a folder lock on a folder, preventing it from being moved and/or deleted.

    ","parent_name":"FoldersModule"},"Classes/FoldersModule.html#/s:6BoxSDK13FoldersModuleC10deleteLock06folderF2Id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteLock(folderLockId:completion:)","abstract":"

    Remove the specified folder lock.

    ","parent_name":"FoldersModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC3get6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"get(fileId:fields:completion:)","abstract":"

    Get information about a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6update6fileId4name11description06parentG010sharedLink4tags11collections4lock7ifMatch6fields10completionySS_SSSgA2pA17NullableParameterOyAA06SharedL4DataVGSgSaySSGSgAxRyAA04LockW0VGSgApXys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"update(fileId:name:description:parentId:sharedLink:tags:collections:lock:ifMatch:fields:completion:)","abstract":"

    Update the information about a file, including renaming or moving the file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4copy6fileId06parentG04name7version6fields10completionySS_S2SSgAKSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"copy(fileId:parentId:name:version:fields:completion:)","abstract":"

    Create a copy of a file in another folder. The original version of the file will not be","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6upload4data4name8parentId8progress21performPreflightCheck10completionAA0A10UploadTaskC10Foundation4DataV_S2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"upload(data:name:parentId:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13uploadVersion7forFile4name17contentModifiedAt4data7ifMatch8progress21performPreflightCheck10completionAA0A10UploadTaskCSS_SSSgAO10Foundation4DataVAOySo10NSProgressCcSbys6ResultOyAA0H0CAA0A8SDKErrorCGctF":{"name":"uploadVersion(forFile:name:contentModifiedAt:data:ifMatch:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12streamUpload0E08fileSize4name8parentId8progress21performPreflightCheck10completionAA0aF4TaskCSo13NSInputStreamC_SiS2SySo10NSProgressCcSbys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"streamUpload(stream:fileSize:name:parentId:progress:performPreflightCheck:completion:)","abstract":"

    Upload a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19streamUploadVersion0E08fileSize7forFile4name17contentModifiedAt7ifMatch8progress21performPreflightCheck10completionAA0aF4TaskCSo13NSInputStreamC_SiS3SSgARySo10NSProgressCcSbys6ResultOyAA0K0CAA0A8SDKErrorCGctF":{"name":"streamUploadVersion(stream:fileSize:forFile:name:contentModifiedAt:ifMatch:progress:performPreflightCheck:completion:)","abstract":"

    Upload a new version of an existing file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14preflightCheck4name8parentId4size10completionAA0A11NetworkTaskCSS_SSs5Int64VSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"preflightCheck(name:parentId:size:completion:)","abstract":"

    Verifies that new file will be accepted by Box before you send all the bytes over the wire.","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC27preflightCheckForNewVersion7forFile4name4size10completionAA0A11NetworkTaskCSS_SSSgs5Int64VSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"preflightCheckForNewVersion(forFile:name:size:completion:)","abstract":"

    Verifies that an updated file will be accepted by Box before you send all the bytes over the wire. It’s used before","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC4lock6fileId9expiresAt19isDownloadPrevented6fields10completionySS_10Foundation4DateVSgSbSgSaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"lock(fileId:expiresAt:isDownloadPrevented:fields:completion:)","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6unlock6fileId6fields10completionySS_SaySSGSgys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"unlock(fileId:fields:completion:)","abstract":"

    Unlock a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getThumbnail7forFile9extension9minHeight0J5Width03maxK00mL010completionySS_AA0F9ExtensionOSiSgA3Nys6ResultOy10Foundation4DataVAA0A8SDKErrorCGctF":{"name":"getThumbnail(forFile:extension:minHeight:minWidth:maxHeight:maxWidth:completion:)","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getEmbedLink7forFile10completionySS_ys6ResultOyAA08ExpiringfG0CAA0A8SDKErrorCGctF":{"name":"getEmbedLink(forFile:completion:)","abstract":"

    Get a URL for creating an embedded preview session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC18listCollaborations7forFile6marker5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSS_SSSgSiSgSaySSGSgtF":{"name":"listCollaborations(forFile:marker:limit:fields:)","abstract":"

    Get all of the collaborations on a file (i.e. all of the users that have access to that file).

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listComments7forFile6offset5limit6fieldsAA14PagingIteratorCyAA7CommentCGSS_SiSgANSaySSGSgtF":{"name":"listComments(forFile:offset:limit:fields:)","abstract":"

    Get all of the comments on a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC9listTasks7forFile6fieldsAA14PagingIteratorCyAA4TaskCGSS_SaySSGSgtF":{"name":"listTasks(forFile:fields:)","abstract":"

    Get all of the tasks for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC8download6fileId14destinationURL7version8progress10completionAA0A12DownloadTaskCSS_10Foundation0I0VSSSgySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"download(fileId:destinationURL:version:progress:completion:)","abstract":"

    Download a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC6delete6fileId7ifMatch10completionySS_SSSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(fileId:ifMatch:completion:)","abstract":"

    Discards a file to the trash. The etag of the file can be included as an ‘If-Match’ header to prevent race conditions.","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14addToFavorites6fileId10completionySS_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"addToFavorites(fileId:completion:)","abstract":"

    Add file to favorites

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15addToCollection6fileId010collectionI010completionySS_SSys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"addToCollection(fileId:collectionId:completion:)","abstract":"

    Add file to particular collection

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19removeFromFavorites6fileId10completionySS_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"removeFromFavorites(fileId:completion:)","abstract":"

    Remove file from favorites

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC20removeFromCollection6fileId010collectionI010completionySS_SSys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"removeFromCollection(fileId:collectionId:completion:)","abstract":"

    Add file to particular collection

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12listVersions6fileId6offset5limit6fieldsAA14PagingIteratorCyAA11FileVersionCGSS_SiSgANSaySSGSgtF":{"name":"listVersions(fileId:offset:limit:fields:)","abstract":"

    Retrieves all file versions on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10getVersion6fileId0gfH06fields10completionySS_SSSaySSGSgys6ResultOyAA04FileF0CAA0A8SDKErrorCGctF":{"name":"getVersion(fileId:fileVersionId:fields:completion:)","abstract":"

    Retrieves a specified file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14promoteVersion6fileId0gfH06fields10completionySS_SSSaySSGSgys6ResultOyAA04FileF0CAA0A8SDKErrorCGctF":{"name":"promoteVersion(fileId:fileVersionId:fields:completion:)","abstract":"

    Promotes the specified file version to the current file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13deleteVersion6fileId0gfH07ifMatch10completionySS_S2SSgys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteVersion(fileId:fileVersionId:ifMatch:completion:)","abstract":"

    Discards the specified file version to the trash.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12getWatermark6fileId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"getWatermark(fileId:completion:)","abstract":"

    Retrieves the watermark on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC14applyWatermark6fileId10completionySS_ys6ResultOyAA0F0CAA0A8SDKErrorCGctF":{"name":"applyWatermark(fileId:completion:)","abstract":"

    Apply or update the watermark on a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC15removeWatermark6fileId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"removeWatermark(fileId:completion:)","abstract":"

    Remove the watermark from a specified file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13getSharedLink7forFile10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getSharedLink(forFile:completion:)","abstract":"

    Gets file with updated shared link

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC13setSharedLink7forFile10unsharedAt6access8password11canDownload10completionySS_AA17NullableParameterOy10Foundation4DateVGSgAA0fG6AccessOSgALySSGSgSbSgys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"setSharedLink(forFile:unsharedAt:access:password:canDownload:completion:)","abstract":"

    Creates of updates shared link for a file

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16deleteSharedLink7forFile10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteSharedLink(forFile:completion:)","abstract":"

    Removes shared link for a file

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11downloadZip4name5items14destinationURL10completionySS_SayAA0F12DownloadItemVG10Foundation0J0Vys6ResultOyAA0fL6StatusCAA0A8SDKErrorCGctF":{"name":"downloadZip(name:items:destinationURL:completion:)","abstract":"

    Creates a zip of multiple files and folders and downloads it.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19createUploadSession8folderId8fileName0J4Size10completionySS_SSs5Int32Vys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createUploadSession(folderId:fileName:fileSize:completion:)","abstract":"

    Create an upload session for uploading a new file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC32createUploadSessionForNewVersion6ofFile8fileName0M4Size10completionySS_SSSgs5Int32Vys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"createUploadSessionForNewVersion(ofFile:fileName:fileSize:completion:)","abstract":"

    Create an upload session for uploading a new file version.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC10uploadPart9sessionId4data6offset9totalSize8progress10completionAA0A10UploadTaskCSS_10Foundation4DataVS2iySo10NSProgressCcys6ResultOyAA0oF0CAA0A8SDKErrorCGctF":{"name":"uploadPart(sessionId:data:offset:totalSize:progress:completion:)","abstract":"

    Upload a part of the file to this session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC22listUploadSessionParts9sessionId6offset5limitAA14PagingIteratorCyAA0F15PartDescriptionVGSS_SiSgAMtF":{"name":"listUploadSessionParts(sessionId:offset:limit:)","abstract":"

    Get list of parts of chunked upload session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC12commitUpload9sessionId5parts4sha111description10sharedLink4tags11collections4lock16contentCreatedAt0q8ModifiedS010completionySS_SayAA0F15PartDescriptionVGS2SSgAA06SharedM4DataVSgSaySSGSgAxA04LockY0VSg10Foundation4DateVSgA3_ys6ResultOyAA4FileCAA0A8SDKErrorCGctF":{"name":"commitUpload(sessionId:parts:sha1:description:sharedLink:tags:collections:lock:contentCreatedAt:contentModifiedAt:completion:)","abstract":"

    Commit upload session after successful upload of all parts.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC11abortUpload9sessionId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"abortUpload(sessionId:completion:)","abstract":"

    Abort chunked upload session.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC16getUploadSession9sessionId10completionySS_ys6ResultOyAA0fG0CAA0A8SDKErrorCGctF":{"name":"getUploadSession(sessionId:completion:)","abstract":"

    Get chunked upload session with ID.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19listRepresentations6fileId18representationHint10completionySS_AA018FileRepresentationJ0OSgys6ResultOySayAA0lM0VGAA0A8SDKErrorCGctF":{"name":"listRepresentations(fileId:representationHint:completion:)","abstract":"

    Get representations for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC24getRepresentationContent6fileId18representationHint9assetPath14destinationURL8progress10completionySS_AA04FilefK0OSS10Foundation0O0VySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"getRepresentationContent(fileId:representationHint:assetPath:destinationURL:progress:completion:)","abstract":"

    Get particular representation for a file.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC22downloadRepresentation9sourceURL011destinationH08progress10completionAA0A12DownloadTaskC10Foundation0H0V_AMySo10NSProgressCcys6ResultOyytAA0A8SDKErrorCGctF":{"name":"downloadRepresentation(sourceURL:destinationURL:progress:completion:)","abstract":"

    Download a file to a specified folder.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC19getVersionRetention11retentionId10completionySS_ys6ResultOyAA04FilefG0CAA0A8SDKErrorCGctF":{"name":"getVersionRetention(retentionId:completion:)","abstract":"

    Retrieves information about a file version retention policy.

    ","parent_name":"FilesModule"},"Classes/FilesModule.html#/s:6BoxSDK11FilesModuleC21listVersionRetentions6fileId0hfI006policyI017dispositionAction0K6Before0K5After5limit6markerAA14PagingIteratorCyAA04FileF9RetentionCGSSSg_A2rA011DispositionL0OSg10Foundation4DateVSgAYSiSgARtF":{"name":"listVersionRetentions(fileId:fileVersionId:policyId:dispositionAction:dispositionBefore:dispositionAfter:limit:marker:)","abstract":"

    Retrieves all file version retentions for the given enterprise.

    ","parent_name":"FilesModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC07getUserC010streamType0G8Position5limitAA14PagingIteratorCyAA5EventCGAA06StreamH0OSg_AA0nI0OSgSiSgtF":{"name":"getUserEvents(streamType:streamPosition:limit:)","abstract":"

    Gets events for the current user associated with the access token.","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC013getEnterpriseC010eventTypes12createdAfter0I6Before14streamPosition5limitAA14PagingIteratorCyAA5EventCGSayAA0Q4TypeOGSg_10Foundation4DateVSgAvA06StreamM0OSgSiSgtF":{"name":"getEnterpriseEvents(eventTypes:createdAfter:createdBefore:streamPosition:limit:)","abstract":"

    Gets events for all users and content in the enterprise. Enterprise events are accessible for one year via the API,","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC13getPollingURL10completionyys6ResultOyAA0F7URLInfoCAA0A8SDKErrorCGc_tF":{"name":"getPollingURL(completion:)","abstract":"

    Gets polling URL for checking new changes in an event stream. Works only for user events.

    ","parent_name":"EventsModule"},"Classes/EventsModule.html#/s:6BoxSDK12EventsModuleC013observeForNewC04with10completionyAA14PollingURLInfoC_ys6ResultOyAA0jL0CAA0A8SDKErrorCGctF":{"name":"observeForNewEvents(with:completion:)","abstract":"

    Makes long-polling request for new changes. Server does not return response immediatelly. It only returns response when either","parent_name":"EventsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC3get11devicePinId6fields10completionySS_SaySSGSgys6ResultOyAA0cH0CAA0A8SDKErrorCGctF":{"name":"get(devicePinId:fields:completion:)","abstract":"

    Retrieves a specified Device Pin.

    ","parent_name":"DevicePinsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC17listForEnterprise12enterpriseId6marker5limit9direction6fieldsAA14PagingIteratorCyAA0C3PinCGSS_SSSgSiSgAA14OrderDirectionOSgSaySSGSgtF":{"name":"listForEnterprise(enterpriseId:marker:limit:direction:fields:)","abstract":"

    Retrieves all Device Pins for an enterprise.

    ","parent_name":"DevicePinsModule"},"Classes/DevicePinsModule.html#/s:6BoxSDK16DevicePinsModuleC6delete11devicePinId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(devicePinId:completion:)","abstract":"

    Deletes the specified Device Pin.

    ","parent_name":"DevicePinsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC3get9commentId6fields10completionySS_SaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"get(commentId:fields:completion:)","abstract":"

    Get information about a comment.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6update9commentId7message6fields10completionySS_SSSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"update(commentId:message:fields:completion:)","abstract":"

    Updates the message for a comment.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6create6itemId0F4Type7message6fields10completionySS_S2SSaySSGSgys6ResultOyAA7CommentCAA0A8SDKErrorCGctF":{"name":"create(itemId:itemType:message:fields:completion:)","abstract":"

    Creates a comment on an item.

    ","parent_name":"CommentsModule"},"Classes/CommentsModule.html#/s:6BoxSDK14CommentsModuleC6delete9commentId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(commentId:completion:)","abstract":"

    Deletes the comment.

    ","parent_name":"CommentsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC4list6offset5limit6fieldsAA14PagingIteratorCyAA0A10CollectionCGSiSg_AMSaySSGSgtF":{"name":"list(offset:limit:fields:)","abstract":"

    Retrieves the collections for the given user.

    ","parent_name":"CollectionsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC12getFavorites6fields10completionySaySSGSg_ys6ResultOyAA0A10CollectionCAA0A8SDKErrorCGctF":{"name":"getFavorites(fields:completion:)","abstract":"

    Retrieve the favorites collection

    ","parent_name":"CollectionsModule"},"Classes/CollectionsModule.html#/s:6BoxSDK17CollectionsModuleC9listItems12collectionId6offset5limit6fieldsAA14PagingIteratorCyAA10FolderItemOGSS_SiSgANSaySSGSgtF":{"name":"listItems(collectionId:offset:limit:fields:)","abstract":"

    Gets all of the files, folders, or web links contained within a collection.

    ","parent_name":"CollectionsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC3get15collaborationId6fields10completionySS_SaySSGSgys6ResultOyAA13CollaborationCAA0A8SDKErrorCGctF":{"name":"get(collaborationId:fields:completion:)","abstract":"

    Get information about a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6create8itemType0F2Id4role12accessibleBy0jkG011canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSAA010AccessibleK0OSbSgSaySSGSgARys6ResultOyAA0R0CAA0A8SDKErrorCGctF":{"name":"create(itemType:itemId:role:accessibleBy:accessibleByType:canViewPath:fields:notify:completion:)","abstract":"

    Create a new collaboration that grants a group access to a file or folder in a specific role.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC17createByUserEmail8itemType0I2Id4role5login11canViewPath6fields6notify10completionySS_SSAA17CollaborationRoleOSSSbSgSaySSGSgAOys6ResultOyAA0T0CAA0A8SDKErrorCGctF":{"name":"createByUserEmail(itemType:itemId:role:login:canViewPath:fields:notify:completion:)","abstract":"

    Create a new collaboration that grants a user to a file or folder in a specific role.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6update15collaborationId4role6status11canViewPath6fields10completionySS_AA17CollaborationRoleOAA0O6StatusOSgSbSgSaySSGSgys6ResultOyAA0O0CAA0A8SDKErrorCGctF":{"name":"update(collaborationId:role:status:canViewPath:fields:completion:)","abstract":"

    Update a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC6delete15collaborationId10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(collaborationId:completion:)","abstract":"

    Delete a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC24listPendingForEnterprise6offset5limit6fieldsAA14PagingIteratorCyAA13CollaborationCGSiSg_AMSaySSGSgtF":{"name":"listPendingForEnterprise(offset:limit:fields:)","abstract":"

    Get information about a collaboration.

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationsModule.html#/s:6BoxSDK20CollaborationsModuleC31getAcceptanceRequirementsStatus15collaborationId10completionySS_ys6ResultOyAA13CollaborationC0fgH0CAA0A8SDKErrorCGctF":{"name":"getAcceptanceRequirementsStatus(collaborationId:completion:)","abstract":"

    Retrieves the acceptance requirements status for a specified collaboration

    ","parent_name":"CollaborationsModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC11listEntries6fields6marker5limitAA14PagingIteratorCyAA0cD5EntryCGSaySSGSg_SSSgSiSgtF":{"name":"listEntries(fields:marker:limit:)","abstract":"

    Returns the list of Allowlist entries for the current Enterprise. Each entry lists type, id,","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC3get2id6fields10completionySS_SaySSGSgys6ResultOyAA0cD5EntryCAA0A8SDKErrorCGctF":{"name":"get(id:fields:completion:)","abstract":"

    Get Collaboration Allowlist Entry by ID.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC6create6domain9direction6fields10completionySS_AA0C9DirectionOSaySSGSgys6ResultOyAA0cD5EntryCAA0A8SDKErrorCGctF":{"name":"create(domain:direction:fields:completion:)","abstract":"

    Create Collaboration Allowlist Entry.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC6delete2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"delete(id:completion:)","abstract":"

    Remove a single item from the Enterprise’s Collaboration Allowlist by id.","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC17listExemptTargets6marker5limit6fieldsAA14PagingIteratorCyAA0cdG6TargetCGSSSg_SiSgSaySSGSgtF":{"name":"listExemptTargets(marker:limit:fields:)","abstract":"

    Returns an interator for listing of Exempt User entries for the current Enterprise.","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC15getExemptTarget2id6fields10completionySS_SaySSGSgys6ResultOyAA0cdgH0CAA0A8SDKErrorCGctF":{"name":"getExemptTarget(id:fields:completion:)","abstract":"

    Returns a specific exempt target for the passed in ID.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC10exemptUser6userId6fields10completionySS_SaySSGSgys6ResultOyAA0cD12ExemptTargetCAA0A8SDKErrorCGctF":{"name":"exemptUser(userId:fields:completion:)","abstract":"

    Creates the Exempt Target entry.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/CollaborationAllowlistModule.html#/s:6BoxSDK28CollaborationAllowlistModuleC18deleteExemptTarget2id10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"deleteExemptTarget(id:completion:)","abstract":"

    Remove a single user from the exempt target list.

    ","parent_name":"CollaborationAllowlistModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC7refresh0E5Token10completionySS_ys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"refresh(refreshToken:completion:)","abstract":"

    Refresh the given token.

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC8getToken8withCode10completionySS_ys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"getToken(withCode:completion:)","abstract":"

    Exchange an authorization code for an access token

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC11revokeToken5token10completionySS_ys6ResultOyytAA0A8SDKErrorCGctF":{"name":"revokeToken(token:completion:)","abstract":"

    Revokes an access or refresh token, rendering it invalid.

    ","parent_name":"AuthModule"},"Classes/AuthModule.html#/s:6BoxSDK10AuthModuleC14downscopeToken06parentF05scope8resource10sharedLink10completionySS_ShyAA0F5ScopeOGSSSgAMys6ResultOyAA0F4InfoCAA0A8SDKErrorCGctF":{"name":"downscopeToken(parentToken:scope:resource:sharedLink:completion:)","abstract":"

    Downscope the token.

    ","parent_name":"AuthModule"},"Classes/FileLogDestination.html#/s:6BoxSDK18FileLogDestinationC7fileURLAC10Foundation0G0V_tcfc":{"name":"init(fileURL:)","abstract":"

    Intializer.

    ","parent_name":"FileLogDestination"},"Classes/FileLogDestination.html#/s:6BoxSDK18FileLogDestinationC5write_5level8category_ys12StaticStringV_AA0D5LevelOAA0D8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message into a file

    ","parent_name":"FileLogDestination"},"Classes/ConsoleLogDestination.html#/s:6BoxSDK21ConsoleLogDestinationC5write_5level8category_ys12StaticStringV_AA0D5LevelOAA0D8CategoryOSays7CVarArg_pGtF":{"name":"write(_:level:category:_:)","abstract":"

    Logs a message into the console

    ","parent_name":"ConsoleLogDestination"},"Classes/MetadataSearchFilter.html#/s:6BoxSDK20MetadataSearchFilterCACycfc":{"name":"init()","abstract":"

    Initializer

    ","parent_name":"MetadataSearchFilter"},"Classes/MetadataSearchFilter.html#/s:6BoxSDK20MetadataSearchFilterC03addE011templateKey05fieldH00I5Value5scope8relationySS_S2SAA0C5ScopeOAA0cE5BoundOtF":{"name":"addFilter(templateKey:fieldKey:fieldValue:scope:relation:)","abstract":"

    Adds a new filter object to our list of filter objects.

    ","parent_name":"MetadataSearchFilter"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC9errorTypeSSvp":{"name":"errorType","abstract":"

    Type of error

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC7messageAA0aC4EnumOvp":{"name":"message","abstract":"

    Error message

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC10stackTraceSaySSGvp":{"name":"stackTrace","abstract":"

    Stack trace

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC5errors5Error_pSgvp":{"name":"error","abstract":"

    Error

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC13getDictionarySDySSypGyF":{"name":"getDictionary()","abstract":"

    Get a dictionary representing BoxSDKError

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:6BoxSDK0A8SDKErrorC11descriptionSSvp":{"name":"description","abstract":"

    Provides error JSON string if found.

    ","parent_name":"BoxSDKError"},"Classes/BoxSDKError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"BoxSDKError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC7requestAA0A18RequestDescriptionVSgvp":{"name":"request","abstract":"

    The components that make up a description of a BoxRequest

    ","parent_name":"BoxAPIError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC8responseAA0A19ResponseDescriptionVSgvp":{"name":"response","abstract":"

    The components that make up a description of a BoxResponse

    ","parent_name":"BoxAPIError"},"Classes/BoxAPIError.html#/s:6BoxSDK0A8APIErrorC13getDictionarySDySSypGyF":{"name":"getDictionary()","abstract":"

    Get a dictionary representing BoxAPIError

    ","parent_name":"BoxAPIError"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5filesAA11FilesModuleCvp":{"name":"files","abstract":"

    Provides File management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7foldersAA13FoldersModuleCvp":{"name":"folders","abstract":"

    Provides Folder management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5usersAA11UsersModuleCvp":{"name":"users","abstract":"

    Provides User management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6groupsAA12GroupsModuleCvp":{"name":"groups","abstract":"

    Provides Group management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8commentsAA14CommentsModuleCvp":{"name":"comments","abstract":"

    Provides Comment management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11sharedItemsAA06SharedE6ModuleCvp":{"name":"sharedItems","abstract":"

    Provides SharedItem management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8webLinksAA03WebE6ModuleCvp":{"name":"webLinks","abstract":"

    Web Links management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6searchAA12SearchModuleCvp":{"name":"search","abstract":"

    Provides search functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11collectionsAA17CollectionsModuleCvp":{"name":"collections","abstract":"

    Provides collections functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14collaborationsAA20CollaborationsModuleCvp":{"name":"collaborations","abstract":"

    Provides collaborations functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC22collaborationAllowListAA28CollaborationAllowlistModuleCvp":{"name":"collaborationAllowList","abstract":"

    Provides collaborations whitelist functionality

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8metadataAA14MetadataModuleCvp":{"name":"metadata","abstract":"

    Metadata management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6eventsAA12EventsModuleCvp":{"name":"events","abstract":"

    Provides Events management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC21metadataCascadePolicyAA08MetadataeF6ModuleCvp":{"name":"metadataCascadePolicy","abstract":"

    Metadata cascade policy.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5trashAA11TrashModuleCvp":{"name":"trash","abstract":"

    Trash management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC10devicePinsAA06DeviceE6ModuleCvp":{"name":"devicePins","abstract":"

    Device Pin management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11recentItemsAA06RecentE6ModuleCvp":{"name":"recentItems","abstract":"

    Recent Items management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8webhooksAA14WebhooksModuleCvp":{"name":"webhooks","abstract":"

    Webhooks management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC5tasksAA11TasksModuleCvp":{"name":"tasks","abstract":"

    Tasks management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC15retentionPolicyAA23RetentionPoliciesModuleCvp":{"name":"retentionPolicy","abstract":"

    Retention policy management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14termsOfServiceAA05TermsE14ServicesModuleCvp":{"name":"termsOfService","abstract":"

    Provides TermsOfService

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC10legalHoldsAA05LegalE6ModuleCvp":{"name":"legalHolds","abstract":"

    Legal Hold Policies management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC15storagePoliciesAA07StorageE6ModuleCvp":{"name":"storagePolicies","abstract":"

    Storage Policies management

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC12signRequestsAA04SignE6ModuleCvp":{"name":"signRequests","abstract":"

    Provides sign requests functionality.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7sessionAA15SessionProtocol_pvp":{"name":"session","abstract":"

    Provides authentication session management.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7headersSDyS2SGSgvp":{"name":"headers","abstract":"

    Requests header.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC13configurationAA0A16SDKConfigurationVvp":{"name":"configuration","abstract":"

    SDK request configuration.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC11isDestroyedSbvp":{"name":"isDestroyed","abstract":"

    Indicates whether this BoxClient instance has been destroyed

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC21favoritesCollectionIdSSSgvp":{"name":"favoritesCollectionId","abstract":"

    ID of user’s favorites collection.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC12networkAgent7session13configurationAcA07NetworkE8Protocol_p_AA07SessionI0_pAA0A16SDKConfigurationVtcfc":{"name":"init(networkAgent:session:configuration:)","abstract":"

    Initializer

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC14withSharedLink3url8passwordAC10Foundation3URLV_SSSgtF":{"name":"withSharedLink(url:password:)","abstract":"

    Creates BoxClient instance based on shared link URL and password.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6asUser6withIdACSS_tF":{"name":"asUser(withId:)","abstract":"

    Creates BoxClient instance based on user identifier.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7destroy10completionyys6ResultOyytAA0A8SDKErrorCGc_tF":{"name":"destroy(completion:)","abstract":"

    Destroys the client, revoking its access tokens and rendering it inoperable.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC13exchangeToken5scope8resource10sharedLink10completionyShyAA0E5ScopeOG_SSSgALys6ResultOyAA0E4InfoCAA0A8SDKErrorCGctF":{"name":"exchangeToken(scope:resource:sharedLink:completion:)","abstract":"

    Exchange the token.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3get3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"get(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP GET method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC4post3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC4post3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"post(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP POST method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters4json10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters13multipartBody8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAA13MultipartFormVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:multipartBody:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC3put3url11httpHeaders15queryParameters4data8progress10completionAA0A10UploadTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGAM4DataVySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"put(url:httpHeaders:queryParameters:data:progress:completion:)","abstract":"

    Performs an HTTP PUT method call on an API endpoint and returns a response - variant for chunked upload.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC7options3url11httpHeaders15queryParameters4json10completionAA0A11NetworkTaskC10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGypSgys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"options(url:httpHeaders:queryParameters:json:completion:)","abstract":"

    Performs an HTTP OPTIONS method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC6delete3url11httpHeaders15queryParameters10completiony10Foundation3URLV_SDyS2SGSDySSAA25QueryParameterConvertible_pSgGys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"delete(url:httpHeaders:queryParameters:completion:)","abstract":"

    Performs an HTTP DELETE method call on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxClient.html#/s:6BoxSDK0A6ClientC8download3url0D14DestinationURL11httpHeaders15queryParameters8progress10completionAA0A12DownloadTaskC10Foundation0G0V_AOSDyS2SGSDySSAA25QueryParameterConvertible_pSgGySo10NSProgressCcys6ResultOyAA0A8ResponseVAA0A8SDKErrorCGctF":{"name":"download(url:downloadDestinationURL:httpHeaders:queryParameters:progress:completion:)","abstract":"

    Performs an HTTP GET method call for downloading on an API endpoint and returns a response.

    ","parent_name":"BoxClient"},"Classes/BoxSDK/Constants.html#/s:6BoxSDKAAC9ConstantsO10rootFolderSSvpZ":{"name":"rootFolder","abstract":"

    Root folder identifier

    ","parent_name":"Constants"},"Classes/BoxSDK/Constants.html#/s:6BoxSDKAAC9ConstantsO11currentUserSSvpZ":{"name":"currentUser","abstract":"

    Current user identifier

    ","parent_name":"Constants"},"Classes/BoxSDK/Constants.html":{"name":"Constants","abstract":"

    Box-specific constants

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC13configurationAA0A16SDKConfigurationVvp":{"name":"configuration","abstract":"

    SDK configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC20defaultConfigurationAA0A16SDKConfigurationVvpZ":{"name":"defaultConfiguration","abstract":"

    Default configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC4authAA10AuthModuleCvp":{"name":"auth","abstract":"

    Auth module providing authorization and token related requests.","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC8clientId0C6Secret11callbackURLABSS_S2SSgtcfc":{"name":"init(clientId:clientSecret:callbackURL:)","abstract":"

    Initializer

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC9getClient5tokenAA0aD0CSS_tFZ":{"name":"getClient(token:)","abstract":"

    Creates BoxClient object based on developer token

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC9getClient5tokenAA0aD0CSS_tF":{"name":"getClient(token:)","abstract":"

    Creates BoxClient with developer token

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC22getDelegatedAuthClient11authClosure8uniqueID9tokenInfo0K5Store10completionyySS_ys6ResultOySS11accessToken_Sd9expiresInts5Error_pGctc_SSAA0qL0CSgAA0qM0_pSgyAJyAA0aF0CAA0A8SDKErrorCGctF":{"name":"getDelegatedAuthClient(authClosure:uniqueID:tokenInfo:tokenStore:completion:)","abstract":"

    Creates BoxClient using JWT token.

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC15getOAuth2Client9tokenInfo0F5Store7context10completionyAA05TokenG0CSg_AA0kH0_pSgSo47ASWebAuthenticationPresentationContextProviding_pys6ResultOyAA0aE0CAA0A8SDKErrorCGctF":{"name":"getOAuth2Client(tokenInfo:tokenStore:context:completion:)","abstract":"

    Creates BoxClient in a completion with OAuth 2.0 type of authentication

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC15getOAuth2Client9tokenInfo0F5Store10completionyAA05TokenG0CSg_AA0jH0_pSgys6ResultOyAA0aE0CAA0A8SDKErrorCGctF":{"name":"getOAuth2Client(tokenInfo:tokenStore:completion:)","abstract":"

    Creates BoxClient in a completion with OAuth 2.0 type of authentication

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC19updateConfiguration10apiBaseURL09uploadApifG016maxRetryAttempts21tokenRefreshThreshold21consoleLogDestination04fileqR019clientAnalyticsInfoy10Foundation0G0VSg_ANSiSgSdSgAA07ConsoleqR0CSgAA04FileqR0CSgAA06ClientuV0VSgtKF":{"name":"updateConfiguration(apiBaseURL:uploadApiBaseURL:maxRetryAttempts:tokenRefreshThreshold:consoleLogDestination:fileLogDestination:clientAnalyticsInfo:)","abstract":"

    Updates current SDK configuration

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html#/s:6BoxSDKAAC16makeAuthorizeURL5state10Foundation0E0VSSSg_tF":{"name":"makeAuthorizeURL(state:)","abstract":"

    Creates OAuth2 authorization URL you can use in browser to authorize.

    ","parent_name":"BoxSDK"},"Classes/BoxSDK.html":{"name":"BoxSDK","abstract":"

    Provides methods for creating BoxSDKClient

    "},"Classes/BoxClient.html":{"name":"BoxClient","abstract":"

    Provides communication with Box APIs. Defines methods for communication with Box APIs

    "},"Classes.html#/s:6BoxSDK0A12APIAuthErrorC":{"name":"BoxAPIAuthError","abstract":"

    Describes authentication errors.

    "},"Classes/BoxAPIError.html":{"name":"BoxAPIError","abstract":"

    Describes API request related errors.

    "},"Classes.html#/s:6BoxSDK0A11CodingErrorC":{"name":"BoxCodingError","abstract":"

    Describes encoding and decoding related errors.

    "},"Classes.html#/s:6BoxSDK0A12NetworkErrorC":{"name":"BoxNetworkError","abstract":"

    Describes network related errors.

    "},"Classes/BoxSDKError.html":{"name":"BoxSDKError","abstract":"

    Describes general SDK errors

    "},"Classes/MetadataSearchFilter.html":{"name":"MetadataSearchFilter","abstract":"

    Provides functionality for creating a Metadata Search Filter.

    "},"Classes/ConsoleLogDestination.html":{"name":"ConsoleLogDestination","abstract":"

    Defines logging into a console

    "},"Classes/FileLogDestination.html":{"name":"FileLogDestination","abstract":"

    Defines logging into a file

    "},"Classes/AuthModule.html":{"name":"AuthModule","abstract":"

    Provides Token management.

    "},"Classes/CollaborationAllowlistModule.html":{"name":"CollaborationAllowlistModule","abstract":"

    Provides Collaborations management.

    "},"Classes/CollaborationsModule.html":{"name":"CollaborationsModule","abstract":"

    Provides Collaborations management.

    "},"Classes/CollectionsModule.html":{"name":"CollectionsModule","abstract":"

    Management of collections of files and folders. The only collection available is the “Favorites”.

    "},"Classes/CommentsModule.html":{"name":"CommentsModule","abstract":"

    Provides Comment management

    "},"Classes/DevicePinsModule.html":{"name":"DevicePinsModule","abstract":"

    Provides DevicePin management.

    "},"Classes/EventsModule.html":{"name":"EventsModule","abstract":"

    Provides Event management.

    "},"Classes/FilesModule.html":{"name":"FilesModule","abstract":"

    Provides File management.

    "},"Classes/FoldersModule.html":{"name":"FoldersModule","abstract":"

    Provides Folder management.

    "},"Classes/GroupsModule.html":{"name":"GroupsModule","abstract":"

    Provides Group management

    "},"Classes/LegalHoldsModule.html":{"name":"LegalHoldsModule","abstract":"

    Provides management of Legal Holds

    "},"Classes/MetadataCascadePolicyModule.html":{"name":"MetadataCascadePolicyModule","abstract":"

    Defines methods for metadata management

    "},"Classes/MetadataModule.html":{"name":"MetadataModule","abstract":"

    Defines methods for metadata management

    "},"Classes/RecentItemsModule.html":{"name":"RecentItemsModule","abstract":"

    Returns information about files that have been accessed by a user not long ago.

    "},"Classes/RetentionPoliciesModule.html":{"name":"RetentionPoliciesModule","abstract":"

    Provides RetentionPolicy management.

    "},"Classes/SearchModule.html":{"name":"SearchModule","abstract":"

    Provides functionality to search for content.

    "},"Classes/SharedItemsModule.html":{"name":"SharedItemsModule","abstract":"

    Provides SharedItem management.

    "},"Classes/SignRequestsModule.html":{"name":"SignRequestsModule","abstract":"

    Provides management of Sign Requests

    "},"Classes/StoragePoliciesModule.html":{"name":"StoragePoliciesModule","abstract":"

    Provides management of Storage Policies

    "},"Classes/TasksModule.html":{"name":"TasksModule","abstract":"

    Provides Tasks management

    "},"Classes/TermsOfServicesModule.html":{"name":"TermsOfServicesModule","abstract":"

    Provides TermsOfService management.

    "},"Classes/TrashModule.html":{"name":"TrashModule","abstract":"

    Module for trash management

    "},"Classes/UsersModule.html":{"name":"UsersModule","abstract":"

    Provides User management.

    "},"Classes/WebLinksModule.html":{"name":"WebLinksModule","abstract":"

    Provides Web Link management.

    "},"Classes/WebhooksModule.html":{"name":"WebhooksModule","abstract":"

    Provides management of Webhooks

    "},"Classes.html#/s:6BoxSDK0A12DownloadTaskC":{"name":"BoxDownloadTask","abstract":"

    A Box network task for a download

    "},"Classes/BoxNetworkAgent.html":{"name":"BoxNetworkAgent","abstract":"

    Implementation of networking layer

    "},"Classes/BoxNetworkTask.html":{"name":"BoxNetworkTask","abstract":"

    A Box network task request.

    "},"Classes.html#/s:6BoxSDK0A10UploadTaskC":{"name":"BoxUploadTask","abstract":"

    A Box network task returned for a upload

    "},"Classes/PagingIterator.html":{"name":"PagingIterator","abstract":"

    Provides paged iterator access for a collection of BoxModel’s

    "},"Classes/BoxRequest.html":{"name":"BoxRequest","abstract":"

    Represents Box SDK API request.

    "},"Classes/BoxCollection.html":{"name":"BoxCollection","abstract":"

    Collections contain information about the items contained inside of them, including files and folders."},"Classes/Classification.html":{"name":"Classification","abstract":"

    Details about the classification applied to a Box file or folder

    "},"Classes/Collaboration.html":{"name":"Collaboration","abstract":"

    Defines access permissions for users and groups to files and folders, similar to access control lists."},"Classes/CollaborationAllowlistEntry.html":{"name":"CollaborationAllowlistEntry","abstract":"

    An allowlisted domain in the enterprise. This record consists of both direction"},"Classes/CollaborationAllowlistExemptTarget.html":{"name":"CollaborationAllowlistExemptTarget","abstract":"

    The record that represents a target (at the moment, only users are supported as targets)"},"Classes/Collaborator.html":{"name":"Collaborator","abstract":"

    User taking part in a collaboration.

    "},"Classes/Comment.html":{"name":"Comment","abstract":"

    Message generated by Box users. Each message is tied to a specific file."},"Classes/DevicePin.html":{"name":"DevicePin","abstract":"

    Defines a device pin which allows the enterprise to control devices connecting to it.

    "},"Classes/EmailAlias.html":{"name":"EmailAlias","abstract":"

    User’s email alias.

    "},"Classes/Enterprise.html":{"name":"Enterprise","abstract":"

    Enterprise

    "},"Classes/EntryContainer.html":{"name":"EntryContainer","abstract":"

    Container for an entries (Box items)

    "},"Classes/Order.html":{"name":"Order","abstract":"

    Defines the order of items

    "},"Classes/EntryContainerInnerModel.html":{"name":"EntryContainerInnerModel","abstract":"

    Entry container for items of inner model

    "},"Classes/Event.html":{"name":"Event","abstract":"

    An event object associated with user or enterprise events.

    "},"Classes/EventContainer.html":{"name":"EventContainer","abstract":"

    Container for Events

    "},"Classes/EventItem.html":{"name":"EventItem","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/ExpiringEmbedLink.html":{"name":"ExpiringEmbedLink","abstract":"

    Expiring embed link of a file

    "},"Classes/File.html":{"name":"File","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/FileVersion.html":{"name":"FileVersion","abstract":"

    Specific version of a file.

    "},"Classes/FileVersionLegalHold.html":{"name":"FileVersionLegalHold","abstract":"

    A file version legal hold object represents all holds on a file version

    "},"Classes/FileVersionRetention.html":{"name":"FileVersionRetention","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/Folder.html":{"name":"Folder","abstract":"

    File objects in Box, with attributes like who created the file, when it was last modified, and other information.

    "},"Classes/FolderLock.html":{"name":"FolderLock","abstract":"

    Folder Lock

    "},"Classes/FolderUploadEmail.html":{"name":"FolderUploadEmail","abstract":"

    Defines upload email address for a folder.

    "},"Classes/Group.html":{"name":"Group","abstract":"

    Contain a set of users, and can be used in place of users in some operations, such as collaborations.

    "},"Classes/GroupMembership.html":{"name":"GroupMembership","abstract":"

    Membership of a group

    "},"Classes/Invite.html":{"name":"Invite","abstract":"

    Defines invitation for a user to join enterprise

    "},"Classes/LegalHoldPolicy.html":{"name":"LegalHoldPolicy","abstract":"

    Legal hold policy

    "},"Classes/LegalHoldPolicyAssignment.html":{"name":"LegalHoldPolicyAssignment","abstract":"

    Legal hold policy assignment

    "},"Classes/LegalHoldPolicyAssignmentItem.html":{"name":"LegalHoldPolicyAssignmentItem","abstract":"

    Legal hold policy assignment item

    "},"Classes/Lock.html":{"name":"Lock","abstract":"

    Locks a file to prevent it from being modified

    "},"Classes/MetadataCascadePolicy.html":{"name":"MetadataCascadePolicy","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/MetadataObject.html":{"name":"MetadataObject","abstract":"

    A metadata object associated with a file or a folder.

    "},"Classes/MetadataTemplate.html":{"name":"MetadataTemplate","abstract":"

    Metadata that belongs to a file or folder is grouped by templates."},"Classes/PathCollection.html":{"name":"PathCollection","abstract":"

    The path of folders to an item, starting at the root.

    "},"Classes/PollingResult.html":{"name":"PollingResult","abstract":"

    An events long polling result.

    "},"Classes/PollingURLInfo.html":{"name":"PollingURLInfo","abstract":"

    Polling URL info for requesting changes in event stream.

    "},"Classes/RecentItem.html":{"name":"RecentItem","abstract":"

    Item recently iteracted with

    "},"Classes/RetentionPolicy.html":{"name":"RetentionPolicy","abstract":"

    A retention policy blocks permanent deletion of content for a specified amount of time.

    "},"Classes/RetentionPolicyAssignment.html":{"name":"RetentionPolicyAssignment","abstract":"

    The retention policy assignment provides a way for admins to apply a retention policy on a per-folder basis,"},"Classes/RetentionPolicyAssignmentItem.html":{"name":"RetentionPolicyAssignmentItem","abstract":"

    The type and id of the content that is under retention.

    "},"Classes/RetentionPolicyEntry.html":{"name":"RetentionPolicyEntry","abstract":"

    Retention policy entry

    "},"Classes/Scope.html":{"name":"Scope","abstract":"

    Permission scope for a token.

    "},"Classes/SearchResult.html":{"name":"SearchResult","abstract":"

    Files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user.

    "},"Classes/SharedItem.html":{"name":"SharedItem","abstract":"

    Item shared by shared link.

    "},"Classes/SharedLink.html":{"name":"SharedLink","abstract":"

    Provides direct, read-only access to files or folder on Box using a URL

    "},"Classes/SignRequest.html":{"name":"SignRequest","abstract":"

    A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

    "},"Classes/SignRequestPrefillTag.html":{"name":"SignRequestPrefillTag","abstract":"

    Prefill tags are used to prefill placeholders with signer input data."},"Classes/SignRequestSignFiles.html":{"name":"SignRequestSignFiles","abstract":"

    List of files that will be signed, which are copies of the original source files."},"Classes/SignRequestSigner.html":{"name":"SignRequestSigner","abstract":"

    Represents a signer fields for GET Sign Request response.

    "},"Classes/SignRequestSignerDecision.html":{"name":"SignRequestSignerDecision","abstract":"

    Final decision made by the signer

    "},"Classes/SignRequestSignerInput.html":{"name":"SignRequestSignerInput","abstract":"

    Prefill tags are used to prefill placeholders with signer input data. Only none value field can be included.

    "},"Classes/StoragePolicy.html":{"name":"StoragePolicy","abstract":"

    Storage policy

    "},"Classes/StoragePolicyAssignment.html":{"name":"StoragePolicyAssignment","abstract":"

    Storage policy assignment

    "},"Classes/Task.html":{"name":"Task","abstract":"

    Enables file-centric workflows in Box. User can create tasks on files and assign them to collaborators on Box."},"Classes/TaskAssignment.html":{"name":"TaskAssignment","abstract":"

    Task assignment to a single user. There can be multiple assignments on a given task.

    "},"Classes/TermsOfService.html":{"name":"TermsOfService","abstract":"

    The Terms of Service allows Box Admins to configure a custom ToS indicating to users."},"Classes/TermsOfServiceUserStatus.html":{"name":"TermsOfServiceUserStatus","abstract":"

    Represents a Terms of Service status for a given user.

    "},"Classes/Token.html":{"name":"Token","abstract":"

    Embed link token

    "},"Classes/TokenInfo.html":{"name":"TokenInfo","abstract":"

    Info about the tokens used by the SDK for authentication.

    "},"Classes/TrackingCode.html":{"name":"TrackingCode","abstract":"

    Admin-defined information about a user

    "},"Classes/UploadPart.html":{"name":"UploadPart","abstract":"

    Object representing part of chunked upload.

    "},"Classes/UploadSession.html":{"name":"UploadSession","abstract":"

    Session object for chunked upload.

    "},"Classes/User.html":{"name":"User","abstract":"

    User of the Box application.

    "},"Classes/Watermark.html":{"name":"Watermark","abstract":"

    Watermark object labels folders and files to be protected by watermarks, which will show on file previews."},"Classes/WebLink.html":{"name":"WebLink","abstract":"

    Object that points to URLs. These objects are also known as bookmarks within the Box web application.

    "},"Classes/Webhook.html":{"name":"Webhook","abstract":"

    Defines a Webhook, which enables event triggers to be attached to Box files and folders

    "},"Classes/ZipDownload.html":{"name":"ZipDownload","abstract":"

    Defines a Zip Download

    "},"Classes/ZipDownloadConflict.html":{"name":"ZipDownloadConflict","abstract":"

    Defines a Zip Download Conflict

    "},"Classes/ZipDownloadConflictItem.html":{"name":"ZipDownloadConflictItem","abstract":"

    Defines a Zip Download Conflict Item

    "},"Classes/ZipDownloadStatus.html":{"name":"ZipDownloadStatus","abstract":"

    Status of a Zip download

    "},"Classes/DelegatedAuthSession.html":{"name":"DelegatedAuthSession","abstract":"

    An authorization session using JWT token

    "},"Classes/OAuth2Session.html":{"name":"OAuth2Session","abstract":"

    OAuth 2 Session

    "},"Classes/SingleTokenSession.html":{"name":"SingleTokenSession","abstract":"

    Developer session that only requires a developer token. Session will only work as long as the token is valid.

    "},"Classes/KeychainTokenStore.html":{"name":"KeychainTokenStore","abstract":"

    Token store that uses the Apple keychain

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file