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

SDLAppServiceRecord Class Reference

Section Contents

Overview

Undocumented

-initWithServiceID:serviceManifest:servicePublished:serviceActive:

Convenience init for all parameters.

Objective-C

- (nonnull instancetype)initWithServiceID:(nonnull NSString *)serviceID
                          serviceManifest:
                              (nonnull SDLAppServiceManifest *)serviceManifest
                         servicePublished:(BOOL)servicePublished
                            serviceActive:(BOOL)serviceActive;

Swift

init(serviceID: String, serviceManifest: SDLAppServiceManifest, servicePublished: Bool, serviceActive: Bool)

Parameters

serviceID

A unique ID tied to this specific service record

serviceManifest

Manifest for the service that this record is for

servicePublished

If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable

serviceActive

If true, the service is the active primary service of the supplied service type.

Return Value

A SDLAppServiceRecord object

serviceID

A unique ID tied to this specific service record. The ID is supplied by the module that services publish themselves.

String, Required

Objective-C

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

Swift

var serviceID: String { get set }

serviceManifest

Manifest for the service that this record is for.

SDLAppServiceManifest, Required

Objective-C

@property (readwrite, strong, nonatomic)
    SDLAppServiceManifest *_Nonnull serviceManifest;

Swift

var serviceManifest: SDLAppServiceManifest { get set }

servicePublished

If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable.

Boolean, Required

Objective-C

@property (readwrite, strong, nonatomic)
    NSNumber<SDLBool> *_Nonnull servicePublished;

Swift

var servicePublished: NSNumber & SDLBool { get set }

serviceActive

If true, the service is the active primary service of the supplied service type. It will receive all potential RPCs that are passed through to that service type. If false, it is not the primary service of the supplied type. See servicePublished for its availability.

Boolean, Required

Objective-C

@property (readwrite, strong, nonatomic)
    NSNumber<SDLBool> *_Nonnull serviceActive;

Swift

var serviceActive: NSNumber & SDLBool { get set }
View on GitHub.com
Previous Section Next Section