summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLScrollableMessage.h
blob: 27e8942211a610781f5d2ae4e399dd6d16f678ab (plain)
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
//  SDLScrollableMessage.h
//


#import "SDLRPCRequest.h"

/**
 * Creates a full screen overlay containing a large block of formatted text that
 * can be scrolled with up to 8 SoftButtons defined
 * <p>
 * Function Group: ScrollableMessage
 * <p>
 * <b>HMILevel needs to be FULL</b>
 * <p>
 */
@interface SDLScrollableMessage : SDLRPCRequest {
}

/**
 * @abstract Constructs a new SDLScrollableMessage object
 */
- (instancetype)init;
/**
 * @abstract Constructs a new SDLScrollableMessage object indicated by the NSMutableDictionary
 * parameter
 * @param dict The dictionary to use
 */
- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

/**
 * @abstract A Body of text that can include newlines and tabs
 * @discussion A String value representing the Body of text that can include
 *            newlines and tabs
 *            <p>
 *            <b>Notes: </b>Maxlength=500
 */
@property (strong) NSString *scrollableMessageBody;
/**
 * @abstract Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the
 * last action
 * @discussion An Integer value representing an App defined timeout in milliseconds
 *            <p>
 *            <b>Notes</b>:Minval=0; Maxval=65535;Default=30000
 */
@property (strong) NSNumber *timeout;
/**
 * @abstract Gets/Sets App defined SoftButtons.If omitted on supported displays, only the
 * system defined "Close" SoftButton will be displayed
 * @discussion A Vector<SoftButton> value representing App defined
 *            SoftButtons
 *            <p>
 *            <b>Notes: </b>Minsize=0, Maxsize=8
 */
@property (strong) NSMutableArray *softButtons;

@end