Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

SDLAppServiceManifest Class Reference

Section Contents

Overview

This manifest contains all the information necessary for the service to be published, activated, and allow consumers to interact with it

-initWithAppServiceType:

Convenience init for serviceType.

Objective-C

- (nonnull instancetype)initWithAppServiceType:
    (nonnull SDLAppServiceType)serviceType;

Swift

init(appServiceType serviceType: SDLAppServiceType)

Parameters

serviceType

The type of service that is to be offered by this app

Return Value

A SDLAppServiceManifest object

-initWithMediaServiceName:serviceIcon:allowAppConsumers:rpcSpecVersion:handledRPCs:mediaServiceManifest:

Convenience init for a media service manifest.

Objective-C

- (nonnull instancetype)
    initWithMediaServiceName:(nullable NSString *)serviceName
                 serviceIcon:(nullable SDLImage *)serviceIcon
           allowAppConsumers:(BOOL)allowAppConsumers
              rpcSpecVersion:(nullable SDLSyncMsgVersion *)rpcSpecVersion
                 handledRPCs:(nullable NSArray<NSNumber<SDLInt> *> *)handledRPCs
        mediaServiceManifest:
            (nullable SDLMediaServiceManifest *)mediaServiceManifest;

Swift

convenience init(mediaServiceName serviceName: String?, serviceIcon: SDLImage?, allowAppConsumers: Bool, rpcSpecVersion: SDLSyncMsgVersion?, handledRPCs: [NSNumber & SDLInt]?, mediaServiceManifest: SDLMediaServiceManifest?)

Parameters

serviceName

Unique name of this service

serviceIcon

The file name of the icon to be associated with this service

allowAppConsumers

If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false

rpcSpecVersion

This is the max RPC Spec version the app service understands

handledRPCs

This field contains the Function IDs for the RPCs that this service intends to handle correctly

mediaServiceManifest

A media service manifest

Return Value

A SDLAppServiceManifest object

-initWithWeatherServiceName:serviceIcon:allowAppConsumers:rpcSpecVersion:handledRPCs:weatherServiceManifest:

Convenience init for a weather service manifest.

Objective-C

- (nonnull instancetype)
    initWithWeatherServiceName:(nullable NSString *)serviceName
                   serviceIcon:(nullable SDLImage *)serviceIcon
             allowAppConsumers:(BOOL)allowAppConsumers
                rpcSpecVersion:(nullable SDLSyncMsgVersion *)rpcSpecVersion
                   handledRPCs:
                       (nullable NSArray<NSNumber<SDLInt> *> *)handledRPCs
        weatherServiceManifest:
            (nullable SDLWeatherServiceManifest *)weatherServiceManifest;

Swift

convenience init(weatherServiceName serviceName: String?, serviceIcon: SDLImage?, allowAppConsumers: Bool, rpcSpecVersion: SDLSyncMsgVersion?, handledRPCs: [NSNumber & SDLInt]?, weatherServiceManifest: SDLWeatherServiceManifest?)

Parameters

serviceName

Unique name of this service

serviceIcon

The file name of the icon to be associated with this service

allowAppConsumers

If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false

rpcSpecVersion

This is the max RPC Spec version the app service understands

handledRPCs

This field contains the Function IDs for the RPCs that this service intends to handle correctly

weatherServiceManifest

A weather service manifest

Return Value

A SDLAppServiceManifest object

-initWithNavigationServiceName:serviceIcon:allowAppConsumers:rpcSpecVersion:handledRPCs:navigationServiceManifest:

Convenience init for a navigation service manifest.

Objective-C

- (nonnull instancetype)
    initWithNavigationServiceName:(nullable NSString *)serviceName
                      serviceIcon:(nullable SDLImage *)serviceIcon
                allowAppConsumers:(BOOL)allowAppConsumers
                   rpcSpecVersion:(nullable SDLSyncMsgVersion *)rpcSpecVersion
                      handledRPCs:
                          (nullable NSArray<NSNumber<SDLInt> *> *)handledRPCs
        navigationServiceManifest:
            (nullable SDLNavigationServiceManifest *)navigationServiceManifest;

Swift

convenience init(navigationServiceName serviceName: String?, serviceIcon: SDLImage?, allowAppConsumers: Bool, rpcSpecVersion: SDLSyncMsgVersion?, handledRPCs: [NSNumber & SDLInt]?, navigationServiceManifest: SDLNavigationServiceManifest?)

Parameters

serviceName

Unique name of this service

serviceIcon

The file name of the icon to be associated with this service

allowAppConsumers

If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false

rpcSpecVersion

This is the max RPC Spec version the app service understands

handledRPCs

This field contains the Function IDs for the RPCs that this service intends to handle correctly

navigationServiceManifest

A navigation service manifest

Return Value

A SDLAppServiceManifest object

-initWithServiceName:serviceType:serviceIcon:allowAppConsumers:rpcSpecVersion:handledRPCs:mediaServiceManifest:weatherServiceManifest:navigationServiceManifest:

Convenience init for all parameters.

Objective-C

- (nonnull instancetype)
          initWithServiceName:(nullable NSString *)serviceName
                  serviceType:(nonnull SDLAppServiceType)serviceType
                  serviceIcon:(nullable SDLImage *)serviceIcon
            allowAppConsumers:(BOOL)allowAppConsumers
               rpcSpecVersion:(nullable SDLSyncMsgVersion *)rpcSpecVersion
                  handledRPCs:
                      (nullable NSArray<NSNumber<SDLInt> *> *)handledRPCs
         mediaServiceManifest:
             (nullable SDLMediaServiceManifest *)mediaServiceManifest
       weatherServiceManifest:
           (nullable SDLWeatherServiceManifest *)weatherServiceManifest
    navigationServiceManifest:
        (nullable SDLNavigationServiceManifest *)navigationServiceManifest;

Swift

convenience init(serviceName: String?, serviceType: SDLAppServiceType, serviceIcon: SDLImage?, allowAppConsumers: Bool, rpcSpecVersion: SDLSyncMsgVersion?, handledRPCs: [NSNumber & SDLInt]?, mediaServiceManifest: SDLMediaServiceManifest?, weatherServiceManifest: SDLWeatherServiceManifest?, navigationServiceManifest: SDLNavigationServiceManifest?)

Parameters

serviceName

Unique name of this service

serviceType

The type of service that is to be offered by this app

serviceIcon

The file name of the icon to be associated with this service

allowAppConsumers

If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false

rpcSpecVersion

This is the max RPC Spec version the app service understands

handledRPCs

This field contains the Function IDs for the RPCs that this service intends to handle correctly

mediaServiceManifest

A media service manifest

weatherServiceManifest

A weather service manifest

navigationServiceManifest

A navigation service manifest

Return Value

A SDLAppServiceManifest object

serviceName

Unique name of this service.

String, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *serviceName;

Swift

var serviceName: String? { get set }

serviceType

The type of service that is to be offered by this app. See AppServiceType for known enum equivalent types. Parameter is a string to allow for new service types to be used by apps on older versions of SDL Core.

String, See SDLAppServiceType, Required

Objective-C

@property (readwrite, strong, nonatomic) NSString *_Nonnull serviceType;

Swift

var serviceType: String { get set }

serviceIcon

The file name of the icon to be associated with this service. Most likely the same as the appIcon.

String, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable) SDLImage *serviceIcon;

Swift

var serviceIcon: SDLImage? { get set }

allowAppConsumers

If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false.

Boolean, Optional, default = NO

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *allowAppConsumers;

Swift

var allowAppConsumers: (NSNumber & SDLBool)? { get set }

rpcSpecVersion

This is the max RPC Spec version the app service understands. This is important during the RPC passthrough functionality. If not included, it is assumed the max version of the module is acceptable.

SyncMsgVersion, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SDLSyncMsgVersion *rpcSpecVersion;

Swift

var rpcSpecVersion: SDLSyncMsgVersion? { get set }

handledRPCs

This field contains the Function IDs for the RPCs that this service intends to handle correctly. This means the service will provide meaningful responses. See FunctionID for enum equivalent values. This parameter is an integer to allow for new function IDs to be used by apps on older versions of SDL Core.

Array of Integers, See SDLFunctionID, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<NSNumber<SDLInt> *> *handledRPCs;

Swift

var handledRPCs: [NSNumber & SDLInt]? { get set }

mediaServiceManifest

A media service manifest.

SDLMediaServiceManifest, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SDLMediaServiceManifest *mediaServiceManifest;

Swift

var mediaServiceManifest: SDLMediaServiceManifest? { get set }

weatherServiceManifest

A weather service manifest.

SDLWeatherServiceManifest, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SDLWeatherServiceManifest *weatherServiceManifest;

Swift

var weatherServiceManifest: SDLWeatherServiceManifest? { get set }

navigationServiceManifest

A navigation service manifest.

SDLNavigationServiceManifest, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SDLNavigationServiceManifest *navigationServiceManifest;

Swift

var navigationServiceManifest: SDLNavigationServiceManifest? { get set }
View on GitHub.com
Previous Section Next Section