BuildAPI

@protocol BuildAPI <NSObject>

Protocol of the Build API methods.

  • Retrieves the bundle of part, materials and colors translations of the owner’s current model and locale.

    To retrieve the bundle of a specific model the method -[BuildAPI getLocaleModel:callback:] should be used.

    Declaration

    Objective-C

    - (void)getLocaleModel:(nonnull void (^)(NSDictionary *_Nonnull))callback;

    Swift

    optional func getLocaleModel(_ callback: ((UnsafeMutablePointer<Int32>?) -> Void)!)

    Parameters

    callback

    The block to be called when the translations bundle is retrieved.
    Show on GitHub

  • Retrieves the bundle part, materials and colors translations of a specific brand and model.

    The options map accepts the following keys:

    • brand - The brand of the model.

    • model - The name of the model.

    • locale - The locale of the translations.

    • compatibility - If compatibility mode should be enabled.

    • prefix - A prefix to prepend to the locale keys (defaults to builds).

    Declaration

    Objective-C

    - (void)getLocaleModel:(nonnull NSDictionary *)options
              callback:(nonnull void (^)(NSDictionary *_Nonnull))callback;

    Swift

    optional func getLocaleModel(_ options: Any!, callback: ((UnsafeMutablePointer<Int32>?) -> Void)!)

    Parameters

    options

    A map of options to configure the request.
    callback

    The block to be called when the translations bundle is retrieved.
    Show on GitHub

  • Retrieves the bundle of part, materials and colors translations of the owner’s current model and locale.

    To retrieve the bundle of a specific model the method -[BuildAPI getLocaleModelP:callback:] should be used.

    Declaration

    Objective-C

    - (nonnull Promise *)getLocaleModelP;

    Swift

    optional func getLocaleModelP() -> Any!

    Return Value

    A Promise that will be resolved with the locale bundle.

    Show on GitHub

  • Retrieves the bundle part, materials and colors translations of a specific brand and model.

    The options map accepts the following keys:

    • brand - The brand of the model.

    • model - The name of the model.

    • locale - The locale of the translations.

    • compatibility - If compatibility mode should be enabled.

    • prefix - A prefix to prepend to the locale keys (defaults to builds).

    Declaration

    Objective-C

    - (nonnull Promise *)getLocaleModelP:(nonnull NSDictionary *)options;

    Swift

    optional func getLocaleModelP(_ options: Any!) -> Any!

    Parameters

    options

    A map of options to configure the request.

    Return Value

    A Promise that will be resolved with the locale bundle.

    Show on GitHub