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 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.