1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
//
// SDLTextAndGraphicManager.h
// SmartDeviceLink
//
// Created by Joel Fischer on 2/22/18.
// Copyright © 2018 smartdevicelink. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SDLMetadataType.h"
#import "SDLTextAlignment.h"
@class SDLArtwork;
@class SDLFileManager;
@class SDLTextAndGraphicConfiguration;
@class SDLSystemCapabilityManager;
@protocol SDLConnectionManagerType;
NS_ASSUME_NONNULL_BEGIN
/**
The handler run when the update has completed
@param error An error if the update failed and an error occurred
*/
typedef void(^SDLTextAndGraphicUpdateCompletionHandler)(NSError *__nullable error);
@interface SDLTextAndGraphicManager : NSObject
/**
A text field that corresponds to SDLShow mainField1. Setting to nil is equivalent to setting an empty string.
*/
@property (copy, nonatomic, nullable) NSString *textField1;
@property (copy, nonatomic, nullable) NSString *textField2;
@property (copy, nonatomic, nullable) NSString *textField3;
@property (copy, nonatomic, nullable) NSString *textField4;
@property (copy, nonatomic, nullable) NSString *mediaTrackTextField;
@property (copy, nonatomic, nullable) NSString *title;
@property (strong, nonatomic, nullable) SDLArtwork *primaryGraphic;
@property (strong, nonatomic, nullable) SDLArtwork *secondaryGraphic;
@property (copy, nonatomic, nullable) SDLTextAlignment alignment;
@property (copy, nonatomic, nullable) SDLMetadataType textField1Type;
@property (copy, nonatomic, nullable) SDLMetadataType textField2Type;
@property (copy, nonatomic, nullable) SDLMetadataType textField3Type;
@property (copy, nonatomic, nullable) SDLMetadataType textField4Type;
/**
* If you want to remove the current artwork, set it to this blank artwork.
*
* This artwork is set to null on disconnects to prevent a `sdl_fileManager_fileDoesNotExistError` error when the artwork is sent again on reconnects.
*/
@property (strong, nonatomic, readonly, nullable) SDLArtwork *blankArtwork;
@property (assign, nonatomic, getter=isBatchingUpdates) BOOL batchUpdates;
- (instancetype)init NS_UNAVAILABLE;
/**
Create a Text and Image Manager with a custom SDLTextAndImageConfiguration.
@return A new SDLTextAndImageManager
*/
- (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager systemCapabilityManager:(SDLSystemCapabilityManager *)systemCapabilityManager;
/// Starts the manager. This method is used internally.
- (void)start;
/**
* Stops the manager. This method is used internally.
*/
- (void)stop;
/**
Update text fields with new text set into the text field properties. Pass an empty string `\@""` to clear the text field.
If the system does not support a full 4 fields, this will automatically be concatenated and properly send the field available.
If 3 lines are available: [field1, field2, field3 - field 4]
If 2 lines are available: [field1 - field2, field3 - field4]
If 1 line is available: [field1 - field2 - field3 - field4]
Also updates the primary and secondary images with new image(s) if new one(s) been set. This method will take care of naming the files (based on a hash). This is assumed to be a non-persistant image.
If it needs to be uploaded, it will be. Once the upload is complete, the on-screen graphic will be updated.
@param handler A handler run when the fields have finished updating, with an error if the update failed. This handler may be called multiple times when the text update is sent and the image update is sent.
*/
- (void)updateWithCompletionHandler:(nullable SDLTextAndGraphicUpdateCompletionHandler)handler;
@end
NS_ASSUME_NONNULL_END
|
