| semilimes mcu sdk 1.1.2 semilimes Software Development Kit for microcontrollers

Loading...
Searching...
No Matches
bucket_update.h
1#ifndef _bucket_update
2#define _bucket_update
3
4#include "../defines.h"
5
6 class BucketUpdate
7{
8 private:
9 SmeJson json_data;
10 char* json = nullptr;
11 char* jsonArray = nullptr;
12
13 public:
14// Function: ~BucketUpdate
15
16// distructor of the class, frees up the memory occupied by the array/s
17
18// Prototype:
19// ~BucketUpdate()
20
21// Parameters:
22
23// Returns:
25 ~BucketUpdate()
26 {
27 delete[] json;
28 delete[] jsonArray;
29 json = nullptr;
30 jsonArray = nullptr;
31 }
32
33// Function: BucketUpdate.set
34
35// This endpoint allows the user to update the content of a specific bucket.
36
37// Prototype:
38// void set(const char* bucketId, const char* title, const char* description, const char* avatar, bool visible, bool locked, bool enReactions);
39
40// Parameters:
48
49// Returns:
51 void set(const char* bucketId, const char* title, const char* description, const char* avatar, bool visible, bool locked, bool enReactions);
52
53// Function: BucketUpdate.addDataComponents
54
55// Prototype:
56// void addDataComponents(const char* component);
57
58// Append the selected components
59
60// Parameters:
62
63// Returns:
65 void addDataComponents(const char* component);
66
67// Function: BucketUpdate.appendDataComponents
68
69// Append the selected dataComponents
70
71// Prototype:
72// void appendDataComponents();
73
74// Parameters:
75
76// Returns:
78 void appendDataComponents();
79
80// Function: BucketUpdate.getEPurl
81
82// provides the full url for this endpoint
83
84// Prototype:
85// char* getEPurl();
86
87// Parameters:
88
89// Returns:
91 char* getEPurl();
92
93// Function: BucketUpdate.getWSEPurl
94
95// provides this endpoint
96
97// Prototype:
98// char* getWSEPurl();
99
100// Parameters:
101
102// Returns:
104 char* getWSEPurl();
105
106// Function: BucketUpdate.get
107
108// return the json script
109
110// Prototype:
111// void BucketUpdate::get();
112
113// Parameters:
114
115// Returns:
117 char* get();
118};
119
120#endif
BucketUpdate
Definition bucket_update.h:7
BucketUpdate::~BucketUpdate
~BucketUpdate()
Definition bucket_update.h:25
BucketUpdate::appendDataComponents
void appendDataComponents()
Definition bucket_update.cpp:80
BucketUpdate::getEPurl
char * getEPurl()
Definition bucket_update.cpp:102
BucketUpdate::getWSEPurl
char * getWSEPurl()
Definition bucket_update.cpp:119
BucketUpdate::addDataComponents
void addDataComponents(const char *component)
Definition bucket_update.cpp:51
BucketUpdate::set
void set(const char *bucketId, const char *title, const char *description, const char *avatar, bool visible, bool locked, bool enReactions)
Definition bucket_update.cpp:22
BucketUpdate::get
char * get()
Definition bucket_update.cpp:136