DEPRECATED: Diffusion iOS Classic API  5.9.4
 All Data Structures Files Functions Variables Enumerations Enumerator Properties Macros Pages
DFTopicDefinition.h
1 //
2 // DFTopicDefinition.h
3 // DiffusionTransport
4 //
5 // Created by Martin Cowie on 23/05/2013 - Diffusion 5.9.4_01
6 // Copyright (c) 2013 Push Technology Ltd. All rights reserved.
7 //
8 
9 /**
10  * This encapsulates all or some of the details of a Topic.
11  * <P>
12  * A Topic definition comprises:-<BR>
13  * 1) A mandatory type that defines the type of Topic Data (if any) associated
14  * with the Topic.<BR>
15  * 2) A set of properties. Some are generic and some are dependent upon the
16  * type. The generic properties are all optional but some type specific ones may
17  * be mandatory.<BR>
18  * 3) A metadata definition which is mandatory for some types. The type of this
19  * metadata is also dependent upon the type.
20  * <P>
21  * This class performs no validation of the settings. If a definition
22  * is used to create a topic and mandatory properties (or metadata) are not
23  * present or one or more values are invalid then topic creation would fail.
24  * <P>
25  * Each property has documented type (e.g. String, Integer, Long etc) and the
26  * property value may be set to an object of that type or any other object that
27  * can be parsed to that type via its toString method. For example to set an
28  * integer property you could specify an Integer (or an int) but you could also
29  * specify a String with a numeric Integer representation within it. However,
30  * if a non numeric value was assigned to an Integer property then a failure
31  * may occur when the property is used.
32  *
33  * @since 4.6
34  */
35 @interface DFTopicDefinition : NSObject
36 
37 
38 @property(readonly,nonatomic) DFTopicDataType type;
39 @property(readonly,nonatomic) NSString *metadata;
40 @property(readonly,nonatomic) NSDictionary *properties;
41 
42 @end