HUBJSONSchemaRegistry

@protocol HUBJSONSchemaRegistry <NSObject>

Protocol defining the public API of a Hub JSON schema registry

You don’t conform to this protocol yourself, instead the application’s HUBManager has an object conforming to this protocol attached to it, that enables you to create and register custom JSON schemas for use in the Hub Framework.

To customize a schema, create one using -createNewSchema, then set up the returned schema to match the JSON format that you are expecting, and finally register it with the registry.

For more information on how Hub Framework JSON schemas work; see HUBJSONSchema.

  • Create a new JSON schema that can be customized for a custom JSON format

    The returned schema comes setup according to the default Hub Framework JSON schema, so you are free to customize only the parts of it that you need to.

    Declaration

    Objective-C

    - (nonnull id<HUBJSONSchema>)createNewSchema;

  • Create a new JSON schema that is a copy of any previously registed schema

    Declaration

    Objective-C

    - (nullable id<HUBJSONSchema>)copySchemaWithIdentifier:
    (nonnull NSString *)identifier;

    Parameters

    identifier

    The identifier of the schema to copy

    Return Value

    A copied schema, or nil if a schema wasn’t found for the given identifier

  • Register a custom JSON schema for use with the Hub Framework

    The identifier that this schema gets registered for must be unique. If another schema has already been registered for the given identifier, an assert will be triggered. To get the Hub Framework to use your custom schema to parse any downloaded JSON, supply its identifier when registering your feature with HUBFeatureRegistry.

    Declaration

    Objective-C

    - (void)registerCustomSchema:(nonnull id<HUBJSONSchema>)schema
               forIdentifier:(nonnull NSString *)identifier;

    Parameters

    schema

    The schema to register
    identifier

    The identifier to register the schema for

  • Unregister a custom JSON schema from the Hub Framework

    Calling this will remove the custom JSON schema from the framework, opening up the identifier for use by other schemas.

    Declaration

    Objective-C

    - (void)unregisterCustomSchemaWithIdentifier:(nonnull NSString *)identifier;

    Parameters

    identifier

    The identifier to unregister a schema for