Updated C stack external API comments for doxygen documentation.
[platform/upstream/iotivity.git] / resource / csdk / stack / include / ocpresence.h
1 //******************************************************************
2 //
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
4 //
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
6 //
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
10 //
11 //      http://www.apache.org/licenses/LICENSE-2.0
12 //
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
18 //
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
20
21 #ifndef OCPRESENCE_H_
22 #define OCPRESENCE_H_
23
24 #ifdef WITH_PRESENCE
25
26 /**
27  * The OCPresenceTrigger enum delineates the three spec-compliant modes for
28  * "Trigger." These enum values are then mapped to  strings
29  * "create", "change", "delete", respectively, before getting encoded into
30  * the payload.
31  */
32 typedef enum
33 {
34     /** The creation of a resource is associated with this invocation. */
35     OC_PRESENCE_TRIGGER_CREATE = 0,
36
37     /** The change/update of a resource is associated this invocation. */
38     OC_PRESENCE_TRIGGER_CHANGE = 1,
39
40     /** The deletion of a resource is associated with this invocation.*/
41     OC_PRESENCE_TRIGGER_DELETE = 2
42 } OCPresenceTrigger;
43 #endif
44
45 #endif