Wasabi ExpressPlay SDK for Embedded Systems  1.10
WsbActionResultInfo.h
Go to the documentation of this file.
1 /*****************************************************************
2 |
3 | Wasabi - Action Result Info API
4 |
5 | $Id: WsbActionResultInfo.h 10793 2014-06-25 12:46:08Z jebaseelir $
6 | Original author: Eric Swenson
7 |
8 | This software is provided to you pursuant to your agreement
9 | with Intertrust Technologies Corporation ("Intertrust").
10 | This software may be used only in accordance with the terms
11 | of the agreement.
12 |
13 | Copyright (c) 2009-2014 by Intertrust. All rights reserved.
14 |
15 ****************************************************************/
21 #ifndef _WSB_ACTION_RESULT_INFO_H_
22 #define _WSB_ACTION_RESULT_INFO_H_
23 
24 /*----------------------------------------------------------------------
25 | includes
26 +---------------------------------------------------------------------*/
27 #include "ShiData.h"
28 #include "WsbTypes.h"
29 #include "ShiAction.h"
30 #include "WsbActionResultConstraint.h"
31 #include "WsbMediaFile.h"
32 #include "ShiEngine.h"
33 
34 /*----------------------------------------------------------------------
35 | result codes
36 +---------------------------------------------------------------------*/
37 #define WSB_ERROR_ARI_HAS_CALLBACKS (WSB_ERROR_BASE_ARI - 0)
38 #define WSB_ERROR_ARI_INVALID_OBLIGATION (WSB_ERROR_BASE_ARI - 1)
39 #define WSB_ERROR_ARI_INVALID_CALLBACK (WSB_ERROR_BASE_ARI - 2)
40 #define WSB_ERROR_ARI_UNSUPPORTED_OBLIGATION (WSB_ERROR_BASE_ARI - 3)
41 
42 /*----------------------------------------------------------------------
43 | interfaces
44 +---------------------------------------------------------------------*/
45 #if defined(__cplusplus)
46 extern "C" {
47 #endif
48 
77 WSB_EXPORT WSB_Result
78 WSB_ExplainActionResultFailure(SHI_ActionResult* action_result,
79  SHI_Engine* engine,
80  WSB_MediaFile* media_file,
81  SHI_Data** goto_url);
82 
86 typedef struct WSB_ActionResultInfo WSB_ActionResultInfo;
87 
99 WSB_EXPORT WSB_Result
100 WSB_ActionResultInfo_Create(SHI_ActionResult* action_result,
101  WSB_ActionResultInfo** info);
102 
110 WSB_EXPORT WSB_Boolean
111 WSB_ActionResultInfo_IsGranted(WSB_ActionResultInfo* info);
112 
122 WSB_EXPORT WSB_Boolean
123 WSB_ActionResultInfo_IsPermanent(WSB_ActionResultInfo* info);
124 
136 WSB_EXPORT WSB_Boolean
137 WSB_ActionResultInfo_MustAccept(WSB_ActionResultInfo* info);
138 
147 WSB_EXPORT WSB_Boolean
148 WSB_ActionResultInfo_HasObligations(WSB_ActionResultInfo* info);
149 
159 WSB_EXPORT WSB_Boolean
160 WSB_ActionResultInfo_HasMandatoryObligations(WSB_ActionResultInfo* info);
161 
170 WSB_EXPORT WSB_Boolean
171 WSB_ActionResultInfo_HasCallbacks(WSB_ActionResultInfo* info);
172 
182 WSB_EXPORT WSB_Boolean
183 WSB_ActionResultInfo_HasMandatoryCallbacks(WSB_ActionResultInfo* info);
184 
199 WSB_EXPORT WSB_Cardinal
200 WSB_ActionResultInfo_GetConstraintCount(WSB_ActionResultInfo* info,
201  WSB_Boolean mandatory_only);
202 
217 WSB_EXPORT WSB_Result
218 WSB_ActionResultInfo_GetConstraintByIndex(WSB_ActionResultInfo* info,
219  WSB_Boolean mandatory_only,
220  WSB_Ordinal indx,
221  WSB_ActionResultConstraint** constraint);
222 
228 WSB_EXPORT WSB_Result
229 WSB_ActionResultInfo_Destroy(WSB_ActionResultInfo* store);
230 
233 #if defined(__cplusplus)
234 }
235 #endif
236 
237 #endif /* _WSB_ACTION_RESULT_INFO_H_ */