|
| 1 | +# com.aspose.email.cloud.sdk.api.CalendarApi |
| 2 | + |
| 3 | +<a name="addCalendarAttachment"></a> |
| 4 | +## **addCalendarAttachment** |
| 5 | +> void addCalendarAttachment(AddCalendarAttachmentRequestData request) |
| 6 | +
|
| 7 | +Adds an attachment to iCalendar file |
| 8 | + |
| 9 | +### **AddCalendarAttachmentRequestData** Parameters |
| 10 | +```java |
| 11 | +public AddCalendarAttachmentRequestData( |
| 12 | + String name, |
| 13 | + String attachment, |
| 14 | + AddAttachmentRequest request) |
| 15 | +``` |
| 16 | + |
| 17 | +Name | Type | Description | Notes |
| 18 | +------------- | ------------- | ------------- | ------------- |
| 19 | + **name** | **String**| Calendar file name in storage | |
| 20 | + **attachment** | **String**| Attachment file name in storage | |
| 21 | + **request** | [**AddAttachmentRequest**](AddAttachmentRequest.md)| Storage name and folder path for calendar and attachment files | |
| 22 | + |
| 23 | +### Return type |
| 24 | + |
| 25 | +void (empty response body) |
| 26 | + |
| 27 | +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to API README]](README.md) |
| 28 | + |
| 29 | +<a name="createCalendar"></a> |
| 30 | +## **createCalendar** |
| 31 | +> void createCalendar(CreateCalendarRequestData request) |
| 32 | +
|
| 33 | +Create calendar file |
| 34 | + |
| 35 | +### **CreateCalendarRequestData** Parameters |
| 36 | +```java |
| 37 | +public CreateCalendarRequestData( |
| 38 | + String name, |
| 39 | + HierarchicalObjectRequest request) |
| 40 | +``` |
| 41 | + |
| 42 | +Name | Type | Description | Notes |
| 43 | +------------- | ------------- | ------------- | ------------- |
| 44 | + **name** | **String**| Calendar file name in storage | |
| 45 | + **request** | [**HierarchicalObjectRequest**](HierarchicalObjectRequest.md)| | |
| 46 | + |
| 47 | +### Return type |
| 48 | + |
| 49 | +void (empty response body) |
| 50 | + |
| 51 | +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to API README]](README.md) |
| 52 | + |
| 53 | +<a name="deleteCalendarProperty"></a> |
| 54 | +## **deleteCalendarProperty** |
| 55 | +> void deleteCalendarProperty(DeleteCalendarPropertyRequestData request) |
| 56 | +
|
| 57 | +Deletes indexed property by index and name. To delete Reminder attachment, use path ReminderAttachment/{ReminderIndex}/{AttachmentIndex} |
| 58 | + |
| 59 | +### **DeleteCalendarPropertyRequestData** Parameters |
| 60 | +```java |
| 61 | +public DeleteCalendarPropertyRequestData( |
| 62 | + String name, |
| 63 | + String memberName, |
| 64 | + String index, |
| 65 | + StorageFolderLocation request) |
| 66 | +``` |
| 67 | + |
| 68 | +Name | Type | Description | Notes |
| 69 | +------------- | ------------- | ------------- | ------------- |
| 70 | + **name** | **String**| iCalendar file name in storage | |
| 71 | + **memberName** | **String**| Indexed property name | |
| 72 | + **index** | **String**| Property index path | |
| 73 | + **request** | [**StorageFolderLocation**](StorageFolderLocation.md)| Storage detail to specify iCalendar file location | |
| 74 | + |
| 75 | +### Return type |
| 76 | + |
| 77 | +void (empty response body) |
| 78 | + |
| 79 | +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to API README]](README.md) |
| 80 | + |
| 81 | +<a name="getCalendar"></a> |
| 82 | +## **getCalendar** |
| 83 | +> [HierarchicalObject](HierarchicalObject.md) getCalendar(GetCalendarRequestData request) |
| 84 | +
|
| 85 | +Get calendar file properties |
| 86 | + |
| 87 | +### **GetCalendarRequestData** Parameters |
| 88 | +```java |
| 89 | +public GetCalendarRequestData( |
| 90 | + String name, |
| 91 | + String folder, |
| 92 | + String storage) |
| 93 | +``` |
| 94 | + |
| 95 | +Name | Type | Description | Notes |
| 96 | +------------- | ------------- | ------------- | ------------- |
| 97 | + **name** | **String**| iCalendar file name in storage | |
| 98 | + **folder** | **String**| Path to folder in storage | [optional] |
| 99 | + **storage** | **String**| Storage name | [optional] |
| 100 | + |
| 101 | +### Return type |
| 102 | + |
| 103 | +[**HierarchicalObject**](HierarchicalObject.md) |
| 104 | + |
| 105 | +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to API README]](README.md) |
| 106 | + |
| 107 | +<a name="getCalendarAttachment"></a> |
| 108 | +## **getCalendarAttachment** |
| 109 | +> [File](File.md) getCalendarAttachment(GetCalendarAttachmentRequestData request) |
| 110 | +
|
| 111 | +Get iCalendar document attachment by name |
| 112 | + |
| 113 | +### **GetCalendarAttachmentRequestData** Parameters |
| 114 | +```java |
| 115 | +public GetCalendarAttachmentRequestData( |
| 116 | + String name, |
| 117 | + String attachment, |
| 118 | + String folder, |
| 119 | + String storage) |
| 120 | +``` |
| 121 | + |
| 122 | +Name | Type | Description | Notes |
| 123 | +------------- | ------------- | ------------- | ------------- |
| 124 | + **name** | **String**| iCalendar document file name | |
| 125 | + **attachment** | **String**| Attachment name or index | |
| 126 | + **folder** | **String**| Path to folder in storage | [optional] |
| 127 | + **storage** | **String**| Storage name | [optional] |
| 128 | + |
| 129 | +### Return type |
| 130 | + |
| 131 | +[**File**](File.md) |
| 132 | + |
| 133 | +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to API README]](README.md) |
| 134 | + |
| 135 | +<a name="getCalendarList"></a> |
| 136 | +## **getCalendarList** |
| 137 | +> [ListResponseOfHierarchicalObjectResponse](ListResponseOfHierarchicalObjectResponse.md) getCalendarList(GetCalendarListRequestData request) |
| 138 | +
|
| 139 | +Get iCalendar files list in folder on storage |
| 140 | + |
| 141 | +### **GetCalendarListRequestData** Parameters |
| 142 | +```java |
| 143 | +public GetCalendarListRequestData( |
| 144 | + String folder, |
| 145 | + Integer itemsPerPage, |
| 146 | + Integer pageNumber, |
| 147 | + String storage) |
| 148 | +``` |
| 149 | + |
| 150 | +Name | Type | Description | Notes |
| 151 | +------------- | ------------- | ------------- | ------------- |
| 152 | + **folder** | **String**| Path to folder in storage | |
| 153 | + **itemsPerPage** | **Integer**| Count of items on page | |
| 154 | + **pageNumber** | **Integer**| Page number | |
| 155 | + **storage** | **String**| Storage name | [optional] |
| 156 | + |
| 157 | +### Return type |
| 158 | + |
| 159 | +[**ListResponseOfHierarchicalObjectResponse**](ListResponseOfHierarchicalObjectResponse.md) |
| 160 | + |
| 161 | +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to API README]](README.md) |
| 162 | + |
| 163 | +<a name="updateCalendarProperties"></a> |
| 164 | +## **updateCalendarProperties** |
| 165 | +> void updateCalendarProperties(UpdateCalendarPropertiesRequestData request) |
| 166 | +
|
| 167 | +Update calendar file properties |
| 168 | + |
| 169 | +### **UpdateCalendarPropertiesRequestData** Parameters |
| 170 | +```java |
| 171 | +public UpdateCalendarPropertiesRequestData( |
| 172 | + String name, |
| 173 | + HierarchicalObjectRequest request) |
| 174 | +``` |
| 175 | + |
| 176 | +Name | Type | Description | Notes |
| 177 | +------------- | ------------- | ------------- | ------------- |
| 178 | + **name** | **String**| iCalendar file name in storage | |
| 179 | + **request** | [**HierarchicalObjectRequest**](HierarchicalObjectRequest.md)| Calendar properties update request | |
| 180 | + |
| 181 | +### Return type |
| 182 | + |
| 183 | +void (empty response body) |
| 184 | + |
| 185 | +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to API README]](README.md) |
| 186 | + |
0 commit comments