Asterisk - The Open Source Telephony Project GIT-master-2de1a68
resource_mailboxes.h
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 2013, Digium, Inc.
5 *
6 * Jonathan Rose <jrose@digium.com>
7 *
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
13 *
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
17 */
18
19/*! \file
20 *
21 * \brief Generated file - declares stubs to be implemented in
22 * res/ari/resource_mailboxes.c
23 *
24 * Mailboxes resources
25 *
26 * \author Jonathan Rose <jrose@digium.com>
27 */
28
29/*
30 * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
31 * !!!!! DO NOT EDIT !!!!!
32 * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
33 * This file is generated by a mustache template. Please see the original
34 * template in rest-api-templates/ari_resource.h.mustache
35 */
36
37#ifndef _ASTERISK_RESOURCE_MAILBOXES_H
38#define _ASTERISK_RESOURCE_MAILBOXES_H
39
40#include "asterisk/ari.h"
41
42/*! Argument struct for ast_ari_mailboxes_list() */
44};
45/*!
46 * \brief List all mailboxes.
47 *
48 * \param headers HTTP headers
49 * \param args Swagger parameters
50 * \param[out] response HTTP response
51 */
52void ast_ari_mailboxes_list(struct ast_variable *headers, struct ast_ari_mailboxes_list_args *args, struct ast_ari_response *response);
53/*! Argument struct for ast_ari_mailboxes_get() */
55 /*! Name of the mailbox */
56 const char *mailbox_name;
57};
58/*!
59 * \brief Retrieve the current state of a mailbox.
60 *
61 * \param headers HTTP headers
62 * \param args Swagger parameters
63 * \param[out] response HTTP response
64 */
65void ast_ari_mailboxes_get(struct ast_variable *headers, struct ast_ari_mailboxes_get_args *args, struct ast_ari_response *response);
66/*! Argument struct for ast_ari_mailboxes_update() */
68 /*! Name of the mailbox */
69 const char *mailbox_name;
70 /*! Count of old messages in the mailbox */
72 /*! Count of new messages in the mailbox */
74};
75/*!
76 * \brief Body parsing function for /mailboxes/{mailboxName}.
77 * \param body The JSON body from which to parse parameters.
78 * \param[out] args The args structure to parse into.
79 * \retval zero on success
80 * \retval non-zero on failure
81 */
83 struct ast_json *body,
85
86/*!
87 * \brief Change the state of a mailbox. (Note - implicitly creates the mailbox).
88 *
89 * \param headers HTTP headers
90 * \param args Swagger parameters
91 * \param[out] response HTTP response
92 */
93void ast_ari_mailboxes_update(struct ast_variable *headers, struct ast_ari_mailboxes_update_args *args, struct ast_ari_response *response);
94/*! Argument struct for ast_ari_mailboxes_delete() */
96 /*! Name of the mailbox */
97 const char *mailbox_name;
98};
99/*!
100 * \brief Destroy a mailbox.
101 *
102 * \param headers HTTP headers
103 * \param args Swagger parameters
104 * \param[out] response HTTP response
105 */
106void ast_ari_mailboxes_delete(struct ast_variable *headers, struct ast_ari_mailboxes_delete_args *args, struct ast_ari_response *response);
107
108#endif /* _ASTERISK_RESOURCE_MAILBOXES_H */
Asterisk RESTful API hooks.
void ast_ari_mailboxes_delete(struct ast_variable *headers, struct ast_ari_mailboxes_delete_args *args, struct ast_ari_response *response)
Destroy a mailbox.
void ast_ari_mailboxes_get(struct ast_variable *headers, struct ast_ari_mailboxes_get_args *args, struct ast_ari_response *response)
Retrieve the current state of a mailbox.
void ast_ari_mailboxes_update(struct ast_variable *headers, struct ast_ari_mailboxes_update_args *args, struct ast_ari_response *response)
Change the state of a mailbox. (Note - implicitly creates the mailbox).
void ast_ari_mailboxes_list(struct ast_variable *headers, struct ast_ari_mailboxes_list_args *args, struct ast_ari_response *response)
List all mailboxes.
int ast_ari_mailboxes_update_parse_body(struct ast_json *body, struct ast_ari_mailboxes_update_args *args)
Body parsing function for /mailboxes/{mailboxName}.
Abstract JSON element (object, array, string, int, ...).
Structure for variables, used for configurations and for channel variables.
const char * args