summaryrefslogtreecommitdiffstats
path: root/inc/libcmis-c/object.h
blob: 8739cffc987b0b1f89861febbae3bce3f0b54d23 (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
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/* libcmis
 * Version: MPL 1.1 / GPLv2+ / LGPLv2+
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License or as specified alternatively below. You may obtain a copy of
 * the License at http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Major Contributor(s):
 * Copyright (C) 2011 SUSE <cbosdonnat@suse.com>
 *
 *
 * All Rights Reserved.
 *
 * For minor contributions see the git repository.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPLv2+"), or
 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
 * in which case the provisions of the GPLv2+ or the LGPLv2+ are applicable
 * instead of those above.
 */
#ifndef _LIBCMIS_OBJECT_H_
#define _LIBCMIS_OBJECT_H_

#include <time.h>

#include "libcmis-c/libcmis-c-api.h"
#include "libcmis-c/types.h"

#ifdef __cplusplus
extern "C" {
#endif

LIBCMIS_C_API void libcmis_vector_object_free( libcmis_vector_object_Ptr vector );
LIBCMIS_C_API size_t libcmis_vector_object_size( libcmis_vector_object_Ptr vector );
LIBCMIS_C_API libcmis_ObjectPtr libcmis_vector_object_get( libcmis_vector_object_Ptr vector, size_t i );


LIBCMIS_C_API void libcmis_object_free( libcmis_ObjectPtr object );

/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_getId( libcmis_ObjectPtr object );

/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_getName( libcmis_ObjectPtr object );

LIBCMIS_C_API libcmis_vector_string_Ptr libcmis_object_getPaths( libcmis_ObjectPtr object );


/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_getBaseType( libcmis_ObjectPtr object );

/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_getType( libcmis_ObjectPtr object );


/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_getCreatedBy( libcmis_ObjectPtr object );
LIBCMIS_C_API time_t libcmis_object_getCreationDate( libcmis_ObjectPtr object );

/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_getLastModifiedBy( libcmis_ObjectPtr object );
LIBCMIS_C_API time_t libcmis_object_getLastModificationDate( libcmis_ObjectPtr object );


/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_getChangeToken( libcmis_ObjectPtr object );
LIBCMIS_C_API bool libcmis_object_isImmutable( libcmis_ObjectPtr object );

/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API libcmis_vector_string_Ptr libcmis_object_getSecondaryTypes( libcmis_ObjectPtr object );

/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_getThumbnailUrl( libcmis_ObjectPtr object );

LIBCMIS_C_API libcmis_vector_rendition_Ptr libcmis_object_getRenditions( libcmis_ObjectPtr object, libcmis_ErrorPtr error );

LIBCMIS_C_API libcmis_ObjectPtr
LIBCMIS_C_API libcmis_object_addSecondaryType( libcmis_ObjectPtr object,
                                 const char* id,
                                 libcmis_vector_property_Ptr properties,
                                 libcmis_ErrorPtr error );

LIBCMIS_C_API libcmis_ObjectPtr
LIBCMIS_C_API libcmis_object_removeSecondaryType( libcmis_ObjectPtr object,
                                    const char* id,
                                    libcmis_ErrorPtr error );

LIBCMIS_C_API libcmis_vector_property_Ptr libcmis_object_getProperties( libcmis_ObjectPtr object );
LIBCMIS_C_API libcmis_PropertyPtr libcmis_object_getProperty( libcmis_ObjectPtr object, const char* name );
LIBCMIS_C_API void libcmis_object_setProperty( libcmis_ObjectPtr object, libcmis_PropertyPtr property );
LIBCMIS_C_API libcmis_ObjectPtr libcmis_object_updateProperties(
        libcmis_ObjectPtr object,
        libcmis_vector_property_Ptr properties,
        libcmis_ErrorPtr error );

LIBCMIS_C_API libcmis_ObjectTypePtr libcmis_object_getTypeDescription( libcmis_ObjectPtr object );
LIBCMIS_C_API libcmis_AllowableActionsPtr libcmis_object_getAllowableActions( libcmis_ObjectPtr object );

LIBCMIS_C_API void libcmis_object_refresh( libcmis_ObjectPtr object, libcmis_ErrorPtr error );
LIBCMIS_C_API time_t libcmis_object_getRefreshTimestamp( libcmis_ObjectPtr object );

LIBCMIS_C_API void libcmis_object_remove( libcmis_ObjectPtr object, bool allVersions, libcmis_ErrorPtr error );

LIBCMIS_C_API void libcmis_object_move( libcmis_ObjectPtr object,
        libcmis_FolderPtr source,
        libcmis_FolderPtr dest,
        libcmis_ErrorPtr error );


/** The resulting value needs to be free'd.
  */
LIBCMIS_C_API char* libcmis_object_toString( libcmis_ObjectPtr object );

#ifdef __cplusplus
}
#endif

#endif