QmuniCoreJS: Qmuni Class Reference
QmuniCoreJS

Public Member Functions

void Qmuni ()
 
void requestBusiness (void name, void firstName, void lastName, void email, void phone, void options)
 
void getApiUrl (void endpoint)
 
void addRecoverQuestion (void question, void answer, void options)
 
void addApplePush (void bundle, void cert, void key, void appToken, void options)
 
void addConversation (void contact, void options)
 
void addContact (void email, void options)
 
void editSMTPHost (void host, void port, void username, void password, void senderName, void senderEmail, void options)
 
void getAppAsset (void appToken, void name, void options)
 
void logout (void options)
 
void getProfilesForRoleList (void roleID, void options)
 
void getEmailTemplateList (void options)
 
void setSessionToken (void sessionToken, void options)
 
void addAppAssetWithFile (void appToken, void name, void fileInputElement, void options)
 
void getContactBatch (void profileId, void options)
 
void setApiServer (void server)
 
void getAssetList (void options)
 
void setWatchers (void conversation, void profiles, void isWatcher, void options)
 
void getSMTPHost (void options)
 
void showDebugLog ()
 
void deleteEmployee (void profileID, void options)
 
void setApiPort (void port)
 
void addProfileRole (void profileID, void roleID, void options)
 
void deleteContact (void id, void options)
 
void getLibraryVersion ()
 
void addAssetWithFile (void name, void fileInputElement, void options)
 
void hideConversationUntilBatch (void epochTime, void conversationList, void options)
 
void addEmailTemplate (void type, void subject, void body, void cc, void bcc, void role, void options)
 
void addContactBatch (void ownerProfileList, void contactProfileList, void createMutualContacts, void options)
 
void deleteAsset (void name, void options)
 
void getContactImage (void id, void options)
 
void deleteClient (void profileID, void options)
 
void initHandlers ()
 
void tryRecoverAnswer (void appToken, void email, void answer, void options)
 
void getRecoverQuestion (void appToken, void email, void options)
 
void editConversation (void id, void subject, void hide, void hideUntil, void options)
 
void getAppList (void options)
 
void resetApiServerRoot (void useHttp)
 
void addIdleTimer (void options)
 
void getSalt (void appToken, void email, void options)
 
void deleteContactBatch (void ownerProfileList, void contactProfileList, void deleteMutualContacts, void options)
 
void getRoleList (void options)
 
void deleteApplePush (void appToken, void options)
 
void getFile (void id, void options)
 
void hideConversationBatch (void hide, void conversationList, void options)
 
void addClient (void profile, void options)
 
void addAudit (void appToken, void target, void handler, void storage, void options)
 
void addParticipant (void profile, void conversation, void options)
 
void updateApiServerRoot ()
 
void findApp (void appToken, void options)
 
void editFile (void id, void hide, void options)
 
void addBusiness (void setup_token, void code, void options)
 
void addEmployee (void profile, void options)
 
void setApi (void protocol, void server, void port, void version)
 
void addFile (void file, void options)
 
void addAssetWithId (void name, void file_id, void options)
 
void setApiVersion (void version)
 
void getProfileRolesList (void options)
 
void getProfile (void options)
 
void addProfile (void appToken, void email, void password, void firstName, void lastName, void options)
 
void getFileList (void done, void options)
 
void addAssetWithJson (void name, void data, void label, void mime, void options)
 
void login (void appToken, void user, void pass, void options)
 
void getCount (void type, void options)
 
void addMessage (void conversation, void content, void files, void options)
 
void getConversationList (void done, void after, void before, void start, void limit, void options)
 
void sendMessage (void message, void options)
 
void editProfile (void firstName, void lastName, void email, void imagePath, void phone, void address, void options)
 
void getAuditList (void appToken, void options)
 
void deleteAppAsset (void appToken, void name, void options)
 
void getEmployeeList (void options)
 
void setApiProtocol (void protocol)
 
void getAttachment (void id, void options)
 
void getFilePreview (void id, void options)
 
void test ()
 
void setDebugKey (void debugKey)
 
void asset (void appToken, void name)
 
void addAppAssetWithId (void appToken, void name, void file_id, void options)
 
void deleteAudit (void appToken, void auditID, void options)
 
void getClientList (void options)
 
void getRequest (void uri, void data, void options)
 
void getProfileByEmail (void email, void options)
 
void addAttachment (void message, void file, void options)
 
void sendEmail (void roleName, void profileList, void options)
 
void getProfileByID (void profile, void options)
 
void deleteProfileRole (void profileID, void roleID, void options)
 
void getAsset (void name, void options)
 
void addSMTPHost (void host, void port, void username, void password, void senderName, void senderEmail, void options)
 
void addAppAssetWithJson (void appToken, void name, void data, void label, void mime, void options)
 
void getEmailTemplate (void id, void options)
 
void getConversation (void id, void start, void limit, void options)
 
void getCountType (void type, void options)
 
void deleteIdleTimer (void options)
 
void getAppAssetList (void appToken, void options)
 
void getApiServer ()
 
void editEmailTemplate (void id, void type, void subject, void body, void cc, void bcc, void role, void options)
 
void getLoginHash (void appToken, void user, void pass, void options)
 
void deleteSMTPHost (void options)
 
void getContactList (void options)
 
void hideDebugLog ()
 
void getApiVersion ()
 
void editPassword (void profile, void email, void appToken, void oldPassword, void newPassword, void options)
 
void addApp (void title, void options)
 
void autoConfigApiServerRoot ()
 
void deleteMessage (void message, void options)
 
void getModifiedConversations (void epochSeconds, void options)
 
void editMessageViewed (void id, void viewed, void options)
 
void recoverPassword (void appToken, void email, void answer, void newPassword, void options)
 
void deleteParticipant (void profile, void conversation, void options)
 
void okay (void options)
 
void getMessage (void id, void options)
 
void deleteEmailTemplate (void id, void options)
 

Static Public Attributes

static int libraryVersion
 

Constructor & Destructor Documentation

◆ Qmuni()

void Qmuni::Qmuni ( )
inline

Member Function Documentation

◆ addApp()

void Qmuni::addApp ( void  title,
void  options 
)
inline

Add an App: adds an App that is controlled by the Business.

Parameters
{text}title - title of the app
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addAppAssetWithFile()

void Qmuni::addAppAssetWithFile ( void  appToken,
void  name,
void  fileInputElement,
void  options 
)
inline

Add Asset by File: creates or overwrites a File and marks it as an Asset for the app the user is currently logged into

Parameters
{text}appToken - token that specifies the application that the Asset belongs to
{text}name The name of the Asset
{htmlobject} fileInputElement - the html input element with type file
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addAppAssetWithId()

void Qmuni::addAppAssetWithId ( void  appToken,
void  name,
void  file_id,
void  options 
)
inline

Add Asset by File Id: creates or overwrites a File as an Asset for the given app

Parameters
{text}appToken - token that specifies the application that the Asset belongs to
{text}name The name of the Asset
{number}file_id Id of the File to be marked as an Asset
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addAppAssetWithJson()

void Qmuni::addAppAssetWithJson ( void  appToken,
void  name,
void  data,
void  label,
void  mime,
void  options 
)
inline

Add Asset by JSON: creates or overwrites a File from JSON and marks it as an Asset for the given app

Parameters
{text}appToken - token that specifies the application that the Asset belongs to
{text}name The name of the Asset
{text}data contents of the File
{text}label Asset will be downloaded with this as its file name
{text}mime mime type that describes to file to be created
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addApplePush()

void Qmuni::addApplePush ( void  bundle,
void  cert,
void  key,
void  appToken,
void  options 
)
inline

Add Apple Push: sends the required Apple push information to allow sending of push messages

Parameters
{text}bundle - the app bundle id used by Apple
{text}cert - the public push certificate
{text}key - the private push certificate
{text}appToken - the qmuni app token for the application the push services are for

◆ addAssetWithFile()

void Qmuni::addAssetWithFile ( void  name,
void  fileInputElement,
void  options 
)
inline

Add Asset by File: creates or overwrites an unencrypted File and marks it as an Asset for the current app

Parameters
{text}name The name of the Asset to look it up by
{htmlobject} fileInputElement - the html input element with type file
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addAssetWithId()

void Qmuni::addAssetWithId ( void  name,
void  file_id,
void  options 
)
inline

Add Asset by File Id: creates or overwrites a File as an Asset for the app the user is currently logged into

Parameters
{text}name The name of the Asset.
{number}file_id Id of the File to be marked as an Asset. Assumes File is decrypted.
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addAssetWithJson()

void Qmuni::addAssetWithJson ( void  name,
void  data,
void  label,
void  mime,
void  options 
)
inline

Add Asset by JSON: creates or overwrites an Asset and linked File for the logged-in app

Parameters
{text}name The name of the Asset
{text}data JSON formatted contents of the Asset
{text}label Asset will be downloaded with this as its file name
{text}mime mime-type that describes the Asset to be created by the API
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addAttachment()

void Qmuni::addAttachment ( void  message,
void  file,
void  options 
)
inline

add Attachment: adds the File as an Attachment to the Message

Deprecated:
The addFile and uploadFiles now cover the functionality provided by addAttachment.
See also
qmuni#addFile|addFile
Parameters
{number}message - message id for the Message to attach the File to
{number}file - file id for the File to attach the Message
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addAudit()

void Qmuni::addAudit ( void  appToken,
void  target,
void  handler,
void  storage,
void  options 
)
inline

Add Audit: starts an audit with the given parameters and records the settings.

Parameters
{String}appToken - token that specifies which application the audit should be added to
{String}target- the specific thing to be audited
{String}handler - how the audit data is going to be stored
{String}storage - where it is going to be stored
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addBusiness()

void Qmuni::addBusiness ( void  setup_token,
void  code,
void  options 
)
inline

Add a Business: add a Business and admin account with the given password

Parameters
{text}setup_token - setup token provided after the Business is approved
{text}code - password used to sign into the Business account
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addClient()

void Qmuni::addClient ( void  profile,
void  options 
)
inline

Manager required - Add Client: Marks a user as a Client.

Parameters
{number}profile - profile Id of the user to mark
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addContact()

void Qmuni::addContact ( void  email,
void  options 
)
inline

Add Contact: adds another users as the current users contact.

Parameters
{text}email - email of the user to be added as a contact
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addContactBatch()

void Qmuni::addContactBatch ( void  ownerProfileList,
void  contactProfileList,
void  createMutualContacts,
void  options 
)
inline

Admin only - Add Contacts in Batch: add multiple contacts at once. For every profile id of ownerProfileList, all profile ids of contactProfileList are added as the owner's contacts.

Parameters
{number[]}ownerProfileList - array of profile ids to receive contacts
{number[]}contactProfileList - array of profile ids to be added to as contacts
{bool}createMutualContacts - when true creates mutual contacts instead of one way
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addConversation()

void Qmuni::addConversation ( void  contact,
void  options 
)
inline

Add conversation: adds a Conversation with a Contact.

Parameters
{number}id - contact id for the contact
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addEmailTemplate()

void Qmuni::addEmailTemplate ( void  type,
void  subject,
void  body,
void  cc,
void  bcc,
void  role,
void  options 
)
inline

Add Email Template: adds an email template

Parameters
{text}type - type of the email template
{text}subject - subject for the email template
{text}body - body text for the email template
{text}cc - visible emails will be sent to these emails in this email template
{text}bcc - hidden emails will be sent to these emails in this email template
{text}role - this email template will only be used for users with this role
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addEmployee()

void Qmuni::addEmployee ( void  profile,
void  options 
)
inline

Add Employee: marks a user as an employee.

Parameters
{number}profile - profile Id of the user to mark
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addFile()

void Qmuni::addFile ( void  file,
void  options 
)
inline

Add File: adds a File. Call uploadFile after this is successful to complete the file upload procedure

Parameters
{object}file - set to null
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addIdleTimer()

void Qmuni::addIdleTimer ( void  options)
inline

Create the idle timer.

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addMessage()

void Qmuni::addMessage ( void  conversation,
void  content,
void  files,
void  options 
)
inline

Add Message: adds the Message as a draft. This only stores the message and does not send it.

Parameters
{number}conversation - conversation id for the conversation the message is being added to
{text}content - content of the message
{number[]}files - array of file ids, one for each file to be attached to/sent with the message
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addParticipant()

void Qmuni::addParticipant ( void  profile,
void  conversation,
void  options 
)
inline

Add Participant: adds the Contact to the Conversation.

Parameters
{number}profile - contact id for the new Participant
{number}conversation - conversation id for the conversation the contact is being added to
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addProfile()

void Qmuni::addProfile ( void  appToken,
void  email,
void  password,
void  firstName,
void  lastName,
void  options 
)
inline

Admin only - Add Profile: Add a profile.

Parameters
{text}appToken - token that specifies the application that the Profile belongs to
{text}email - email for the profile
{text}password - password for the profile
{text}firstName - first name of the the profile
{text}lastName - last name of the the profile
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addProfileRole()

void Qmuni::addProfileRole ( void  profileID,
void  roleID,
void  options 
)
inline

Add Role to a Profile : gives the Role to the Profile

Parameters
{number}profileID - id of the profile that receives the role
{number}roleID - id of the role to give to the profile
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addRecoverQuestion()

void Qmuni::addRecoverQuestion ( void  question,
void  answer,
void  options 
)
inline

Add Recover Question: assign a recovery question for the profile that is currently logged-in

Parameters
{text}question - the recovery question to be prompted for account recovery requests
{text}answer - the answer to the recovery question
{Object}options - options for the request; includes done, fail, and always callbacks

◆ addSMTPHost()

void Qmuni::addSMTPHost ( void  host,
void  port,
void  username,
void  password,
void  senderName,
void  senderEmail,
void  options 
)
inline

add SMTP Host: creates a SMTP host with the given parameters

Parameters
{text}host
{text}port
{text}username
{text}password
{text}senderName
{text}senderEmail
{Object}options - options for the request; includes done, fail, and always callbacks

◆ asset()

void Qmuni::asset ( void  appToken,
void  name 
)
inline

Returns the URL for an Asset using its label and optional appToken

Parameters
{text}appToken(optional) - provide appToken for public Assets
{text}name - Asset name

◆ autoConfigApiServerRoot()

void Qmuni::autoConfigApiServerRoot ( )
inline

Always callback is always called if the request after the request alwaysCallBack

◆ deleteAppAsset()

void Qmuni::deleteAppAsset ( void  appToken,
void  name,
void  options 
)
inline

Delete Asset: removes an asset from the asset list for the given app

Parameters
{text}appToken - token that specifies the application that the Asset belongs to
{text}name The name of the asset
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteApplePush()

void Qmuni::deleteApplePush ( void  appToken,
void  options 
)
inline

◆ deleteAsset()

void Qmuni::deleteAsset ( void  name,
void  options 
)
inline

Delete Asset: removes an Asset from the Asset list

Parameters
{text}name The name of the Asset
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteAudit()

void Qmuni::deleteAudit ( void  appToken,
void  auditID,
void  options 
)
inline

Delete Audit: stops auditing procedure for the given audit

Parameters
{String}appToken - token that specifies which application the audit belongs to
{Int}auditID - id of the audit to stop
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteClient()

void Qmuni::deleteClient ( void  profileID,
void  options 
)
inline

Manager required - Delete Client: Removes the user as a Client.

Parameters
{number}profileID - profile Id of the user to remove
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteContact()

void Qmuni::deleteContact ( void  id,
void  options 
)
inline

Delete Contact: Removes the Contact from the current users Contact list.

Parameters
{number}id - contact id of the user to remove from the current users contact list
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteContactBatch()

void Qmuni::deleteContactBatch ( void  ownerProfileList,
void  contactProfileList,
void  deleteMutualContacts,
void  options 
)
inline

Admin only - Delete Contacts in Batch: Remove multiple contacts at once. For every profile id of ownerProfileList, all profile ids of contactProfileList are removed from the owner's contacts.

Parameters
{number[]}ownerProfileList - array of profile ids to have contacts removed
{number[]}contactProfileList - array of profile ids to be removed as contacts
{bool}createMutualContacts - when true mutually removes contacts instead of one way
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteEmailTemplate()

void Qmuni::deleteEmailTemplate ( void  id,
void  options 
)
inline

Delete Email Template: deletes the target Email Template for the current app.

Parameters
{number}id - id of the email template to be deleted
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteEmployee()

void Qmuni::deleteEmployee ( void  profileID,
void  options 
)
inline

Manager required - Delete Employee: Removes the user as a employee.

Parameters
{number}profileID - profile Id of the user to remove
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteIdleTimer()

void Qmuni::deleteIdleTimer ( void  options)
inline

Remove the idle timer.

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteMessage()

void Qmuni::deleteMessage ( void  message,
void  options 
)
inline

Delete Message: marks as a message as deleted and all the associated data (files, file keys, ect)

Parameters
{number}message - message id for the message to delete
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteParticipant()

void Qmuni::deleteParticipant ( void  profile,
void  conversation,
void  options 
)
inline

Delete Participant: remove the Contact from the Conversation.

Parameters
{number}profile - contact id for the participant that is going to be removed
{number}conversation - conversation id for the conversation the contact is being removed from
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteProfileRole()

void Qmuni::deleteProfileRole ( void  profileID,
void  roleID,
void  options 
)
inline

delete Role from a Profile : removes the Role from the Profile

Parameters
{number}profileID - id of the profile to lose the role
{number}roleID - id of the role to tale awau from the profile
{Object}options - options for the request; includes done, fail, and always callbacks

◆ deleteSMTPHost()

void Qmuni::deleteSMTPHost ( void  options)
inline

delete SMTP Host: removes the logged in users current SMTP Host settings

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ editConversation()

void Qmuni::editConversation ( void  id,
void  subject,
void  hide,
void  hideUntil,
void  options 
)
inline

Edit Conversation: changes a Conversation visibility and subject.

Parameters
{number}id - conversation id for the conversation to change
{text}subject - new subject for the conversation
{number}hide - update hidden boolean value
{number}hideUntil - hides conversation until specified time using Unix epoch time
{Object}options - options for the request; includes done, fail, and always callbacks

◆ editEmailTemplate()

void Qmuni::editEmailTemplate ( void  id,
void  type,
void  subject,
void  body,
void  cc,
void  bcc,
void  role,
void  options 
)
inline

Edit Email Template: changes the values of an Email Template.

Parameters
{number}id - id for the email template to change
{text}type - type of the email template
{text}subject - subject for the email template
{text}body - body text for the email template
{text}cc - visible emails will be sent to these emails in this email template
{text}bcc - hidden emails will be sent to these emails in this email template
{text}role - this email template will only be used for users with this role
{Object}options - options for the request; includes done, fail, and always callbacks

◆ editFile()

void Qmuni::editFile ( void  id,
void  hide,
void  options 
)
inline

Edit File: changes a File visibility.

Parameters
{number}id - File id for the File to change
{number}hide - update hidden boolean value
{Object}options - options for the request; includes done, fail, and always callbacks

◆ editMessageViewed()

void Qmuni::editMessageViewed ( void  id,
void  viewed,
void  options 
)
inline

Edit Message Viewed: changes the viewed status of a Message

Parameters
{number}id - message id for the message to be changed
{number}viewed - 1 or 0 to mark the message as viewed or not
{Object}options - options for the request; includes done, fail, and always callbacks

◆ editPassword()

void Qmuni::editPassword ( void  profile,
void  email,
void  appToken,
void  oldPassword,
void  newPassword,
void  options 
)
inline

Admin only - change Password.

Parameters
{number}profile - profile id for the profile being targeted
{text}email - email of the profile
{text}appToken - token that specifies the application that the Profile belongs to
{text}oldPassword - old password of the profile
{text}newPassword - new password of the profile
{Object}options - options for the request; includes done, fail, and always callbacks

◆ editProfile()

void Qmuni::editProfile ( void  firstName,
void  lastName,
void  email,
void  imagePath,
void  phone,
void  address,
void  options 
)
inline

Edit Profile: Change data of the current user

Parameters
{text}firstName - user's new first name
{text}lastName - user's new last name
{text}email - user's new email
{text}imagePath - location of the user's new profile image
{text}phone - user's new phone number
{text}address - user's new address
{Object}options - options for the request; includes done, fail, and always callbacks

◆ editSMTPHost()

void Qmuni::editSMTPHost ( void  host,
void  port,
void  username,
void  password,
void  senderName,
void  senderEmail,
void  options 
)
inline

edit SMTP Host: changes the current SMTP host settings to the given parameters

Parameters
{text}host
{text}port
{text}username
{text}password
{text}senderName
{text}senderEmail
{Object}options - options for the request; includes done, fail, and always callbacks

◆ findApp()

void Qmuni::findApp ( void  appToken,
void  options 
)
inline

Find App: Check if the app exists using an application token

Parameters
{text}appToken - token of the app to check the status of
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getApiServer()

void Qmuni::getApiServer ( )
inline

Returns the ip address that the library is sending request to

◆ getApiUrl()

void Qmuni::getApiUrl ( void  endpoint)
inline

Generates the url for the endpoint. Does not work for assets or appAssets

Parameters
{text}endpoint - name of the endpoint for the url

◆ getApiVersion()

void Qmuni::getApiVersion ( )
inline

Returns the version of the api in use by the library.

◆ getAppAsset()

void Qmuni::getAppAsset ( void  appToken,
void  name,
void  options 
)
inline

Get Asset: gets a specific asset for the given app

Parameters
{text}appToken - token that specifies the application that the Asset belongs to
{text}name The name of the Asset
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getAppAssetList()

void Qmuni::getAppAssetList ( void  appToken,
void  options 
)
inline

Get Asset List: Gets a list of all assets for the given app

Parameters
{text}appToken - token that specifies the application that the Asset belongs to
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getAppList()

void Qmuni::getAppList ( void  options)
inline

List all apps that belong to the current user

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getAsset()

void Qmuni::getAsset ( void  name,
void  options 
)
inline

Get Asset: gets a specific Asset for the app the user is currently logged into

Parameters
{text}name The name of the Asset
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getAssetList()

void Qmuni::getAssetList ( void  options)
inline

Get Asset List: Gets a list of all Assets for the app the user is currently logged into

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getAttachment()

void Qmuni::getAttachment ( void  id,
void  options 
)
inline

Get Attachment: Gets the attachment

Deprecated:
The getFile method now cover the functionality provided by getAttachment.
See also
[getFile]getFile
Parameters
{number}id - attachment id for the File to download
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getAuditList()

void Qmuni::getAuditList ( void  appToken,
void  options 
)
inline

Get Audit List: gets list of all the current audits for the specified app

Parameters
{String}appToken - token that specifies which application's audits should be retrieved
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getClientList()

void Qmuni::getClientList ( void  options)
inline

Get Client List: Gets a list of all users marked as a Client.

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getContactBatch()

void Qmuni::getContactBatch ( void  profileId,
void  options 
)
inline

Admin only - Get Contacts in Batch: gets the contact list of a specific profile

Parameters
{number}profileId - the profile id of the profile who's contact list is desired
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getContactImage()

void Qmuni::getContactImage ( void  id,
void  options 
)
inline

Get Contact Image: gets the profile image of a Contact.

Parameters
{number}id - contact id for the contact
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getContactList()

void Qmuni::getContactList ( void  options)
inline

Get Contact List: Gets a list of all of the current users Contacts.

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getConversation()

void Qmuni::getConversation ( void  id,
void  start,
void  limit,
void  options 
)
inline

Get Conversations: gets the data for the specific Conversation.

Parameters
{number}id - conversation id for the conversation
{number}[start=0] - conversations when sorted ascending by modified index greater than start
{number}[limit=10] - number of conversations to return that match
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getConversationList()

void Qmuni::getConversationList ( void  done,
void  after,
void  before,
void  start,
void  limit,
void  options 
)
inline

Get Conversation List: gets the list of conversations the current user is a part of.

Parameters
{bool}[done=false] - list visible or hidden conversations defaults to visible conversations
{number}[after=null] - conversations with a last message after the given date using Unix epoch time
{number}[before=null] - conversation with a last message before the given date using Unix epoch time
{number}[start=0] - conversations when sorted ascending by modified index greater than start
{number}[limit=10] - number of conversations to return that match
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getCount()

void Qmuni::getCount ( void  type,
void  options 
)
inline

Get Count: get statistics for the current user

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getCountType()

void Qmuni::getCountType ( void  type,
void  options 
)
inline

Get Count: get a specific statistic by type for the current user

Parameters
{text}type - the type of statistic to get (currently supports "new_message" only)
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getEmailTemplate()

void Qmuni::getEmailTemplate ( void  id,
void  options 
)
inline

Get Email Templates: gets the data for the specific Email Template.

Parameters
{number}id - id of the email template
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getEmailTemplateList()

void Qmuni::getEmailTemplateList ( void  options)
inline

Get Email Template List: gets the list of Email Templates for the current app.

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getEmployeeList()

void Qmuni::getEmployeeList ( void  options)
inline

Get Employee List: Gets a list of all users marked as an employee.

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getFile()

void Qmuni::getFile ( void  id,
void  options 
)
inline

Get File: downloads the File

Parameters
{number}id - file id for the file to download
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getFileList()

void Qmuni::getFileList ( void  done,
void  options 
)
inline

Get File List: gets a list of all Files the current user has access to

Parameters
{bool}[done=false] - list visible or hidden files, defaults to visible files
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getFilePreview()

void Qmuni::getFilePreview ( void  id,
void  options 
)
inline

Get File Preview: gets the File to preview

Parameters
{number}id - file id for the File to preview
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getLibraryVersion()

void Qmuni::getLibraryVersion ( )
inline

Returns the version of the library

◆ getLoginHash()

void Qmuni::getLoginHash ( void  appToken,
void  user,
void  pass,
void  options 
)
inline

getLoginHash: generates the hash required to login using qcryptor

Parameters
{text}appToken - token that specifies the application to add the session to
{text}user - email for the account
{text}pass - password for the account
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getMessage()

void Qmuni::getMessage ( void  id,
void  options 
)
inline

Get Message: Gets the Message details

Parameters
{number}id - message id for the message to get
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getModifiedConversations()

void Qmuni::getModifiedConversations ( void  epochSeconds,
void  options 
)
inline

get Modified Conversations: returns a list of conversations that were modified after the provided date

Parameters
{number}epochSeconds - seconds after epoch for the oldest modification to be captured.
{Object}options - options for the request; done, fail, and always callbacks.

◆ getProfile()

void Qmuni::getProfile ( void  options)
inline

Get Profile: Gets data of the currently logged in user.

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getProfileByEmail()

void Qmuni::getProfileByEmail ( void  email,
void  options 
)
inline

Admin only - Get Profile by Email: gets the profile data of a user given their email

Parameters
{text}email - email to look up the profile with
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getProfileByID()

void Qmuni::getProfileByID ( void  profile,
void  options 
)
inline

Get Profile: Returns profile details for the profile with the matching profile id. Requires manager login

Parameters
[in]int64_tprofileID the ID of the profile for the data requested
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfileRolesList()

void Qmuni::getProfileRolesList ( void  options)
inline

Get Profile Roles: get list of all roles for the current application

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getProfilesForRoleList()

void Qmuni::getProfilesForRoleList ( void  roleID,
void  options 
)
inline

get profile for the role: gets list of all profile that share the role

Parameters
{number}roleID - id of role that all users in the list will share
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getRecoverQuestion()

void Qmuni::getRecoverQuestion ( void  appToken,
void  email,
void  options 
)
inline

Get Recover Question: retrieve a recovery question for a profile that is not logged-in

Parameters
{text}appToken - the application token associated with the profile
{text}email - the email address associated with the profile
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getRequest()

void Qmuni::getRequest ( void  uri,
void  data,
void  options 
)
inline

Arbitrary GET requests to external websites.

Parameters
{text}uri - the destination for the GET request
{object}data - the response data returned from the GET request
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getRoleList()

void Qmuni::getRoleList ( void  options)
inline

Get Role List: get list of all roles for the given app

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getSalt()

void Qmuni::getSalt ( void  appToken,
void  email,
void  options 
)
inline

Get Salt: gets the Salts required to hash the user's password

Parameters
{text}appToken - token that specifies the application that the salts belong to
{text}email - email for the user whose salt is being requested
{Object}options - options for the request; includes done, fail, and always callbacks

◆ getSMTPHost()

void Qmuni::getSMTPHost ( void  options)
inline

get SMTP Host: returns the logged in users current SMTP Host settings

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ hideConversationBatch()

void Qmuni::hideConversationBatch ( void  hide,
void  conversationList,
void  options 
)
inline

hide Conversation Batch: hides or unhides the list of conversations

Parameters
{number}hide - update hidden boolean value
{text}conversationList - list of conversation IDs to be hidden
{Object}options - options for the request; done, fail, and always callbacks.

◆ hideConversationUntilBatch()

void Qmuni::hideConversationUntilBatch ( void  epochTime,
void  conversationList,
void  options 
)
inline

hide Conversation Batch: hides the conversation list until the given time

Parameters
{number}epochTime - the time since the epoch when the conversations will be moved back to the viable list
{text}conversationList - list of conversation IDs to be hidden
{Object}options - options for the request; done, fail, and always callbacks.

◆ hideDebugLog()

void Qmuni::hideDebugLog ( )
inline

Hide Debug Log: turn off debug messages in the console

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ initHandlers()

void Qmuni::initHandlers ( )
inline

◆ login()

void Qmuni::login ( void  appToken,
void  user,
void  pass,
void  options 
)
inline

Login: add a session for the application with the given credentials

Parameters
{text}appToken - token that specifies the application to add the session to
{text}user - email for the account
{text}pass - password for the account
{Object}options - options for the request; includes done, fail, and always callbacks

◆ logout()

void Qmuni::logout ( void  options)
inline

Logout: Deletes the session for the the current user and application

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ okay()

void Qmuni::okay ( void  options)
inline

Okay: resets the idle timer on the API

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ recoverPassword()

void Qmuni::recoverPassword ( void  appToken,
void  email,
void  answer,
void  newPassword,
void  options 
)
inline

Recover Password:

Parameters
{text}appToken - the application token associated with the profile
{text}email - the email address associated with the profile
{text}answer - the answer to the recovery question
{text}newPassword - a new password for the profile
{Object}options - options for the request; includes done, fail, and always callbacks

◆ requestBusiness()

void Qmuni::requestBusiness ( void  name,
void  firstName,
void  lastName,
void  email,
void  phone,
void  options 
)
inline

Request a Business: request a new Qmuni billable business account for admins

Parameters
{text}name - name of the business
{text}first_name - billing first name
{text}last_name - billing last name
{text}email - billing email
{text}phone - billing phone number
{Object}options - options for the request; includes done, fail, and always callbacks

◆ resetApiServerRoot()

void Qmuni::resetApiServerRoot ( void  useHttp)
inline

◆ sendEmail()

void Qmuni::sendEmail ( void  roleName,
void  profileList,
void  options 
)
inline

Send Email: sends an email email to each profile owner POST /email with object constructed from profileList param

Parameters
{array}profileList - array of profile ids that emails will be send to
{Object}options - options for the request; includes done, fail, and always callbacks

◆ sendMessage()

void Qmuni::sendMessage ( void  message,
void  options 
)
inline

Send Message: adds the previously added Message to the Conversation the Message is a part of.

Parameters
{number}id - message id for the message to be added
{Object}options - options for the request; includes done, fail, and always callbacks

◆ setApi()

void Qmuni::setApi ( void  protocol,
void  server,
void  port,
void  version 
)
inline

Changes the API connection details: protocol, server, port, and version

Parameters
{text}protocol - sets the api protocol (e.g. http, https)
{text}server - sets the api server (e.g. api.qmuni.com)
{text}port - sets the api port (e.g. 9090, 9091)
{text}version - sets the api version (e.g. 1)

◆ setApiPort()

void Qmuni::setApiPort ( void  port)
inline

Changes the API connection port.

Parameters
{text}port - sets the api port (e.g. 9090, 9091)

◆ setApiProtocol()

void Qmuni::setApiProtocol ( void  protocol)
inline

Changes the API connection protocol.

Parameters
{text}protocol - sets the api protocol (e.g. http, https)

◆ setApiServer()

void Qmuni::setApiServer ( void  server)
inline

Changes the API connection server.

Parameters
{text}server - sets the api server (e.g. api.qmuni.com)

◆ setApiVersion()

void Qmuni::setApiVersion ( void  version)
inline

Changes the API connection version.

Parameters
{text}version - sets the api version (e.g. 1)

◆ setDebugKey()

void Qmuni::setDebugKey ( void  debugKey)
inline

◆ setSessionToken()

void Qmuni::setSessionToken ( void  sessionToken,
void  options 
)
inline

Update Session Token: Changes or sets the session token

Parameters
{text}sessionToken - session token
{Object}options - options for the request; includes done, fail, and always callbacks

◆ setWatchers()

void Qmuni::setWatchers ( void  conversation,
void  profiles,
void  isWatcher,
void  options 
)
inline

Set Watchers: set a group of profiles watchers status for a conversation

Parameters
{number}conversation the id of the conversation whos participants are changing watcher status
{array}watcherProfiles list of profile ids of the profiles whos watcher status is changing
{bool}isWatcher if the profiles for the conversation are being set as a watcher or not
{Object}options - options for the request; includes done, fail, and always callbacks

◆ showDebugLog()

void Qmuni::showDebugLog ( )
inline

Show DebugLog: displays debug messages in the console

Parameters
{Object}options - options for the request; includes done, fail, and always callbacks

◆ test()

void Qmuni::test ( )
inline

A simple test function to check if logging works.

◆ tryRecoverAnswer()

void Qmuni::tryRecoverAnswer ( void  appToken,
void  email,
void  answer,
void  options 
)
inline

Try Recover Answer:

Parameters
{text}appToken - the application token associated with the profile
{text}email - the email address associated with the profile
{text}answer - the answer to the recovery question
{Object}options - options for the request; includes done, fail, and always callbacks

◆ updateApiServerRoot()

void Qmuni::updateApiServerRoot ( )
inline

Member Data Documentation

◆ libraryVersion

int Qmuni::libraryVersion
static


QmuniCoreC++: Qmuni::Core Class Reference
QmuniCoreC++

#include <qmuni.h>

Public Member Functions

 Core ()
 
 ~Core ()
 
CoregetGlobals ()
 
const string & getQID () const
 
const string & getAppToken () const
 
void setProtocol (const string &protocol)
 
void setVersion (const string &version)
 
void setServer (const string &server)
 
void setPort (const string &port)
 
void setSecurePort (const string &securePort)
 
string getHomeDir ()
 
void setCredentials (const string &private_key, const string &QID, const string &appToken)
 
void setContactID (int64_t contact_id)
 
void enable_logging ()
 
void disable_logging ()
 
void toggle_logging ()
 
Result addContact (const string &email)
 
Result addConversation (int64_t contact_id=0)
 
Result addFile ()
 
Result addMessage (const int64_t conversation_id, const string &contents, int list_restrict_time_limit, int list_extend_time_limit_if_forward, int forward_restrict_time_limit, std::vector< int64_t > files)
 
Result addMessage (const int64_t conversation_id, const string &contents, std::vector< int64_t > files, int forward_time_limit)
 
Result editMessage (const int64_t message_id, const string &key, int value)
 
Result deleteMessage (const int64_t message_id)
 
Result getModifiedConversations (const int64_t epochSeconds)
 
Result getModifiedList (const int64_t epochSeconds, const string &resource)
 
Result addProfile (const string &app_token, const string &email, const string &new_password)
 
Result getApps ()
 
Result addApp (const string &title)
 
Result addProfile (const string &app_token, const string &email, const string &new_password, const string &type)
 
Result deleteClient (int64_t profileID)
 
Result deleteEmployee (int64_t profileID)
 
Result requestBusiness (const string &name, const string &fname, const string &lname, const string &email, const string &phone)
 
Result addBusiness (const string &setup_token, const string &code)
 
Result addBusinessQcryptor (const string &setup_token, const string &code, const string &salt)
 
Result addBusinessSimple (const string &setup_token, const string &code, const string &salt)
 
Result getBusiness (const string &setup_token)
 
Result getSalt (const string &email, const string &app_token)
 
Result addProfile (const string &app_token, const string &email, const string &new_password, const string &first_name, const string &last_name, const string &phone)
 
Result getProfile (const string &email)
 
Result getProfile (const int64_t &profileID)
 
Result editPassword (int64_t profile_id, const string &email, const string &new_password, const string &old_password)
 
Result qcryptorEditPassword (int64_t profile_id, const string &new_hash1, const string &salt1, const string &old_hash1, const string &old_salt2)
 
Result addPushToken (const string &token)
 
Result attachFile (int64_t file_id, int64_t message_id)
 
Result deleteContact (const int64_t contact_id)
 
Result editConversation (int64_t conversation_id, const string &subject, int hide, int64_t hide_until)
 
Result getProfileImage (int64_t profile_id, const string &file_name, const string &path)
 
Result getContactList ()
 
Result addBatchContacts (std::vector< string > owner_profile_list, std::vector< string > contact_profile_list, bool mutual_contacts)
 
Result getBatchContacts (int64_t profile_id)
 
Result deleteBatchContacts (std::vector< string > owner_profile_list, std::vector< string > contact_profile_list, bool mutual_contacts)
 
Result addEmailTemplate (const string &type, const string &subject, const string &body, const string &cc, const string &bcc)
 
Result addEmailTemplate (const string &role, const string &type, const string &subject, const string &body, const string &cc, const string &bcc)
 
Result getEmailTemplate (const int64_t id)
 
Result editEmailTemplate (const int64_t id, const string &type, const string &subject, const string &body, const string &cc, const string &bcc)
 
Result getEmailTemplateList ()
 
Result deleteEmailTemplate (const int64_t id)
 
Result sendWelcomeEmail (const string &role, std::vector< int64_t > profileList)
 
Result getConversation (int64_t id)
 
Result getConversationList (const string &start_date, const string &end_date)
 
Result getConversation (const int64_t &id, const map< string, string > &queryParams)
 
Result getConversationList (bool areHidden, const map< string, string > &queryParams)
 
Result getCount ()
 
Result getCountType (const string &type)
 
Result addParticipant (int64_t conversation_id, int64_t profile_id)
 
Result deleteParticipant (int64_t conversation_id, int64_t profile_id)
 
Result setWatchers (const int64_t &conversationID, vector< int64_t > &watcherProfiles, bool isWatcher)
 
Result addProfileRole (const int64_t profileID, const int64_t roleID)
 
Result getProfilesForRoleList (const int64_t roleID)
 
Result getProfileRolesList ()
 
Result deleteProfileRole (const int64_t profileID, const int64_t roleID)
 
Result getFile (const int64_t file_id, const string &file_name, const string &destination)
 
Result getFileSimple (const int64_t file_id, const string &file_name, const string &destination)
 
Result getFileList ()
 
Result getHiddenFileList ()
 
Result getFilePreview (int64_t file_id, const string &file_name, const string &destination)
 
Result getHiddenConversationList ()
 
Result getMessage (int64_t message_id)
 
Result getMessageList ()
 
Result getRoleList ()
 
Result getPrivateKey ()
 
Result getProfile ()
 
Result hideConversation (int64_t conversation_id)
 
Result hideConversationUntil (int64_t conversation_id, const string &date)
 
Result hideConversationBatch (bool shouldHide, std::vector< int64_t > conversation_id)
 
Result hideConversationUntilBatch (std::vector< int64_t > conversation_id, const string &date)
 
Result login (const string &email, const string &code, const string &app_token)
 
Result loginSimple (const string &email, const string &code, const string &app_token)
 
Result getLoginHash (const string &email, const string &code, const string &app_token)
 
Result logout ()
 
Result getRecoveryQuestion ()
 
Result getRecoveryQuestion (const string &email, const string &result)
 
Result addRecoveryQuestion (const string &question, const string &answer)
 
Result qcryptorAddRecoveryQuestion (const string &question, const string &answer, const string &salt1)
 
Result getRecoveryAnswer (const string &email, const string &app_token, const string &answer)
 
Result qcryptorGetRecoveryAnswer (const string &email, const string &app_token, const string &answer, const string &salt1, const string &salt2)
 
Result editRecoveredCode (const string &email, const string &app_token, const string &new_code, const string &recovery_answer, const string &private_key, const string &private_key_salt)
 
Result qcryptorEditRecoveredCode (const string &email, const string &app_token, const string &new_hash1, const string &new_salt1, const string &answer_hash1, const string &answer_salt2, const string &private_key, const string &private_key_salt)
 
Result ok ()
 
Result qcryptorAddProfile (const string &app_token, const string &email, const string &code, const string &salt1, const string &first_name, const string &last_name, const string &phone)
 
Result qcryptorLogin (const string &email, const string &hash, const string &appToken)
 
Result sendFile (const string &path, const map< string, string > &file_headers, std::vector< int64_t > contacts=std::vector< int64_t >(0))
 
Result sendFileSimple (const string &path, const map< string, string > &file_headers)
 
Result updateHiddenFile (const int64_t &file_id, const bool shouldHide)
 
Result sendMessage (int64_t message_id, bool push_notify)
 
Result sendMessage (int64_t message_id, std::vector< int64_t > &contacts, bool push_notify)
 
Result sendMessageSimple (int64_t message_id, bool push_notify)
 
Result shareFile (int64_t file_id, int64_t contact_id)
 
Result shareFile (int64_t file_id, std::vector< int64_t > contacts)
 
Result addSMTPHost (const string &host, const string &port, const string &username, const string &password, const string &senderName, const string &senderEmail)
 
Result getSMTPHost ()
 
Result editSMTPHost (const string &host, const string &port, const string &username, const string &password, const string &senderName, const string &senderEmail)
 
Result deleteSMTPHost ()
 
Result unhideConversation (int64_t conversation_id)
 
Result updateFile (const int64_t file_id, const string &path, const map< string, string > &file_headers, std::vector< int64_t > contacts=std::vector< int64_t >(0))
 
Result updateFileQcryptor (const int64_t file_id, const string &path, const map< string, string > &file_headers, std::vector< int64_t > contacts=std::vector< int64_t >(0))
 
Result addAsset (const string &name, const string &path, const map< string, string > &file_headers)
 
Result addAsset (const string &name, const int64_t file_id)
 
Result addAsset (const string &name, const string &data, const string &label, const string &mime)
 
Result getAsset ()
 
Result getAsset (const string &name, const string &destination)
 
Result updateAsset (const string &name, const string &path, const map< string, string > &file_headers)
 
Result updateAsset (const string &name, const int64_t file_id)
 
Result updateAsset (const string &name, const string &data, const string &label, const string &mime)
 
Result deleteAsset (const string &name)
 
Result addAppAsset (const string &app_token, const string &name, const string &path, const map< string, string > &file_headers)
 
Result addAppAsset (const string &app_token, const string &name, const int64_t file_id)
 
Result addAppAsset (const string &app_token, const string &name, const string &data, const string &label, const string &mime)
 
Result getAppAsset (const string &app_token)
 
Result getAppAsset (const string &app_token, const string &name, const string &destination)
 
Result updateAppAsset (const string &app_token, const string &name, const string &path, const map< string, string > &file_headers)
 
Result updateAppAsset (const string &app_token, const string &name, const int64_t file_id)
 
Result updateAppAsset (const string &app_token, const string &name, const string &data, const string &label, const string &mime)
 
Result deleteAppAsset (const string &app_token, const string &name)
 
Result updateProfile (const string &key, const string &value)
 
Result updateProfileImage (const string &path, const std::map< std::string, std::string > &file_headers)
 
Result sendWelcomeEmail (std::vector< int64_t > profiles)
 
Result getAuditList (const string &app_token)
 
Result addAudit (const string &app_token, const string &target, const string &handler, const string &storage)
 
Result deleteAudit (const string &app_token, const int64_t audit_id)
 

Static Public Member Functions

static string getBaseUri ()
 
static string getProtocol ()
 
static string getVersion ()
 
static string getServer ()
 
static string getPort ()
 
static string getSecurePort ()
 
static string extractFileNameFromInput (const string &fileName)
 
static string getFileNameFromDisposition (const string &disposition)
 
static void logMessage (const string &message, int logLevel=8)
 

Constructor & Destructor Documentation

◆ Core()

Qmuni::Core::Core ( )

◆ ~Core()

Qmuni::Core::~Core ( )

Member Function Documentation

◆ addApp()

Result Qmuni::Core::addApp ( const string &  title)

Add App: Creates an Application with the provided title

Parameters
[in]stringtitle title for the app to create

◆ addAppAsset() [1/3]

Result Qmuni::Core::addAppAsset ( const string &  app_token,
const string &  name,
const string &  path,
const map< string, string > &  file_headers 
)

Add App Asset by File: adds a file and marks it as an asset for the app the user is currently logged into

Parameters
[in]stringname The name of the asset to look it up by
[in]stringpath The absolute or relative path for the asset to upload
[in]map<string,string>headers HTTP file headers
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addAppAsset() [2/3]

Result Qmuni::Core::addAppAsset ( const string &  app_token,
const string &  name,
const int64_t  file_id 
)

Add App Asset by File ID: marks a file as an asset for an app

Parameters
[in]stringapp_token The token of the app
[in]stringname The name of the asset to look it up by
[in]int64_tfile_id ID of the file to be marked as an asset
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addAppAsset() [3/3]

Result Qmuni::Core::addAppAsset ( const string &  app_token,
const string &  name,
const string &  data,
const string &  label,
const string &  mime 
)

Add App Asset by JSON: creates a file from json and marks it as an asset for an app

Parameters
[in]stringapp_token The token of the app
[in]stringname The name of the asset to look it up by
[in]stringdata contents of the file
[in]stringlabel file name to use when downloading the file created
[in]stringmime mime type that describes to file to be created
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addAsset() [1/3]

Result Qmuni::Core::addAsset ( const string &  name,
const string &  path,
const map< string, string > &  file_headers 
)

Add Asset by File: adds a file and marks it as an asset for the app the user is currently logged into

Parameters
[in]stringname The name of the asset to look it up by
[in]stringpath The absolute or relative path for the asset to upload
[in]map<string,string>headers HTTP file headers
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addAsset() [2/3]

Result Qmuni::Core::addAsset ( const string &  name,
const int64_t  file_id 
)

Add Asset by File ID: marks a file as an asset for the app the user is currently logged into

Parameters
[in]stringname The name of the asset to look it up by
[in]int64_tfile_id ID of the file to be marked as an asset
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addAsset() [3/3]

Result Qmuni::Core::addAsset ( const string &  name,
const string &  data,
const string &  label,
const string &  mime 
)

Add Asset by JSON: creates a file from json and marks it as an asset for the app the user is currently logged into

Parameters
[in]stringname The name of the asset to look it up by
[in]stringdata contents of the file
[in]stringlabel file name to use when downloading the file created
[in]stringmime mime type that describes to file to be created
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addAudit()

Result Qmuni::Core::addAudit ( const string &  app_token,
const string &  target,
const string &  handler,
const string &  storage 
)

Add Audit: starts an audit with the given parameters and records the settings.

Parameters
[in]stringappToken token that specifies which application the should be added to
[in]stringtarget the specific thing to be audited
[in]stringhandler - how the audit data is going to be stored
[in]stringstorage - where it is going to be stored
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addBatchContacts()

Result Qmuni::Core::addBatchContacts ( std::vector< string >  owner_profile_list,
std::vector< string >  contact_profile_list,
bool  mutual_contacts 
)

Add Contacts in Batch: each owner profile gets all contact profiles as contacts and visa versa if mutual contacts is true

Parameters
[in]vector<string>owner_profile_list list of all profile IDs to receive contacts in batch
[in]vector<string>contact_profile_list list of all profile IDs to be given as contacts in batch
[in]boolmutual_contacts if contact profile ids should get owner profile ids as contacts as well
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addBusiness()

Result Qmuni::Core::addBusiness ( const string &  setup_token,
const string &  code 
)

Add Business: After the business request is approved submit an setup token and password to create a Business

Parameters
[in]stringsetup_token setup token provided after being approved
[in]codecode to restrict access to manage the business
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addBusinessQcryptor()

Result Qmuni::Core::addBusinessQcryptor ( const string &  setup_token,
const string &  code,
const string &  salt 
)

Add Business: After the business request is approved submit an setup token and password to create a Business

Parameters
[in]stringsetup_token setup token provided after being approved
[in]codecode to restrict access to manage the business hashed with salt
[in]saltsalt used to create hash
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addBusinessSimple()

Result Qmuni::Core::addBusinessSimple ( const string &  setup_token,
const string &  code,
const string &  salt 
)

Add Business: After the business request is approved submit an setup token and password to qcryptor inorder to create a Business

Parameters
[in]stringsetup_token setup token provided after being approved
[in]codecode to restrict access to manage the business hashed with salt
[in]saltsalt used to create hash
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addContact()

Result Qmuni::Core::addContact ( const string &  email)

Add Contact: Adds a contact to the current users contact list.

Parameters
[in]stringemail address of the user the current user would like to add to their contact list.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addConversation()

Result Qmuni::Core::addConversation ( int64_t  contact_id = 0)

Add Conversations: Creates a conversation with the logged in user and the user in their contact list with the given contact_id [in] int64_t contact_id ID number used to identify a contact in the logged in users contact list

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addEmailTemplate() [1/2]

Result Qmuni::Core::addEmailTemplate ( const string &  type,
const string &  subject,
const string &  body,
const string &  cc,
const string &  bcc 
)

Add Email Template: adds an email template

Parameters
[in]stringtype type of the email template
[in]stringsubject subject for the email template
[in]stringbody body text for the email template
[in]stringcc visible emails will be sent to these emails in this email template
[in]stringbcc hidden emails will be sent to these emails in this email template
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addEmailTemplate() [2/2]

Result Qmuni::Core::addEmailTemplate ( const string &  role,
const string &  type,
const string &  subject,
const string &  body,
const string &  cc,
const string &  bcc 
)

Add Email Template: adds an email template

Parameters
[in]stringrole the profile role the template will apply to
[in]stringtype type of the email template
[in]stringsubject subject for the email template
[in]stringbody body text for the email template
[in]stringcc visible emails will be sent to these emails in this email template
[in]stringbcc hidden emails will be sent to these emails in this email template
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addFile()

Result Qmuni::Core::addFile ( )

Add Blank File: Creates an empty file record

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addMessage() [1/2]

Result Qmuni::Core::addMessage ( const int64_t  conversation_id,
const string &  contents,
int  list_restrict_time_limit,
int  list_extend_time_limit_if_forward,
int  forward_restrict_time_limit,
std::vector< int64_t >  files 
)

Add Message: Creates a message with the given contents in the given conversation and parameters.

Parameters
[in]int64_tconversation_id ID of the conversation this message is a part of
[in]stringcontent The content of the message being created.
[in]intlist_restrict_time_limit time limit in seconds until this message is marked as hidden
[in]intlist_extend_time_limit_if_forward time in seconds to extend the mark as hidden count down by each time this message is forwarded
[in]intforward_restrict_time_limit time in seconds until this message can no longer be forwarded
[in]vector<int64_t>files list of files by id to be sent with the message
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addMessage() [2/2]

Result Qmuni::Core::addMessage ( const int64_t  conversation_id,
const string &  contents,
std::vector< int64_t >  files,
int  forward_time_limit 
)

Add Message: Creates a message with the given contents in the given conversation.

Parameters
[in]int64_tconversation_id ID of the conversation this message is a part of
[in]stringcontent The content of the message being created.
[in]vector<int64_t>files list of files by id to be sent with the message
[in]intforward_time_limit The duration in seconds that the message can be forwarded. 0 is no limit
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addParticipant()

Result Qmuni::Core::addParticipant ( int64_t  conversation_id,
int64_t  profile_id 
)
Parameters
[in]int64_tconversation_id id of the conversation to add the participant to
[in]int64_tprofile_id id of the profile to add as a participant to the conversation
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addProfile() [1/3]

Result Qmuni::Core::addProfile ( const string &  app_token,
const string &  email,
const string &  new_password 
)

Add Profile: Creates a qmuni profile. Requires user to be logged in as admin

Parameters
[in]stringapp_token a token that represents which app to create the profile for.
[in]stringemail Email address to associate with the new account
[in]stringnew_password Password used to login to the new account with
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addProfile() [2/3]

Result Qmuni::Core::addProfile ( const string &  app_token,
const string &  email,
const string &  new_password,
const string &  type 
)

Add Profile: creates a profile with the provided email address and password and sets to the Type.

Parameters
[in]stringapp_token a token that represents which app to create the profile for.
[in]stringemail Email address to create a new profile with.
[in]stringpassword password to login to the account with
[in]stringtype the type of profile it is. Ex. Client or Employee
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addProfile() [3/3]

Result Qmuni::Core::addProfile ( const string &  app_token,
const string &  email,
const string &  new_password,
const string &  first_name,
const string &  last_name,
const string &  phone 
)

Add Profile: creates a profile with the provided email address and password and sets to the Type.

Parameters
[in]stringapp_token a token that represents which app to create the profile for.
[in]stringemail Email address to create a new profile with.
[in]stringpassword password to login to the account with
[in]stringfirst_name first name of the person the account belongs to
[in]stringlast_name last name of the person the account belongs to
[in]stringphone phone number of the person the account belongs to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addProfileRole()

Result Qmuni::Core::addProfileRole ( const int64_t  profileID,
const int64_t  roleID 
)

Add Role to a Profile : gives the Role to the Profile

Parameters
[in]int64_tprofileID - id of the profile that receives the role
[in]int64_troleID - id of the role to give to the profile
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addPushToken()

Result Qmuni::Core::addPushToken ( const string &  token)

Add Push Token: add push token to qmuni to be used to send push notifications

Parameters
[in]stringtoken push token generated by the application
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addRecoveryQuestion()

Result Qmuni::Core::addRecoveryQuestion ( const string &  question,
const string &  answer 
)

Add Recovery Question: add or replaces the current recovery question for the logged in user

Parameters
[in]Stringquestion the recovery question being added
[in]Stringanswer the answer to the recovery question being added
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addSMTPHost()

Result Qmuni::Core::addSMTPHost ( const string &  host,
const string &  port,
const string &  username,
const string &  password,
const string &  senderName,
const string &  senderEmail 
)

add SMTP Host: creates a SMTP host with the given parameters

Parameters
[in]stringhost
[in]stringport
[in]stringusername
[in]stringpassword
[in]stringsenderName
[in]stringsenderEmail
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ attachFile()

Result Qmuni::Core::attachFile ( int64_t  file_id,
int64_t  message_id 
)

Attach File: Associates a given file id with a given message id.

Parameters
[in]int64_tmessage_id ID that is going to host the file.
[in]int64_tfile_id ID of the file to associate with the messsage.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteAppAsset()

Result Qmuni::Core::deleteAppAsset ( const string &  app_token,
const string &  name 
)

Delete AppAsset: removes an asset from the asset list

Parameters
[in]stringapp_token The token of the app
[in]stringname The name of the asset to look it up by
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteAsset()

Result Qmuni::Core::deleteAsset ( const string &  name)

Delete Asset: removes an asset from the asset list

Parameters
[in]stringname The name of the asset to look it up by
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteAudit()

Result Qmuni::Core::deleteAudit ( const string &  app_token,
const int64_t  audit_id 
)

Delete Audit: stops auditing procedure for the given audit

Parameters
[in]appTokentoken that specifies which application's audit belongs to
[in]auditIDid of the audit to stop
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteBatchContacts()

Result Qmuni::Core::deleteBatchContacts ( std::vector< string >  owner_profile_list,
std::vector< string >  contact_profile_list,
bool  mutual_contacts 
)

Delete Contacts in Batch: each owner profile loses all contact profiles as contacts and visa versa if mutual

Parameters
[in]vector<string>owner_profile_list list of all profile IDs to lose contacts in batch
[in]vector<string>contact_profile_list list of all profile IDs to lose as contacts in batch
[in]boolmutual_contacts if contact profile ids should lose owner profile ids as contacts as well
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteClient()

Result Qmuni::Core::deleteClient ( int64_t  profileID)

Manager required - Delete Client: Removes the user as a Client.

Parameters
[in]int64_tprofileID id of the user to remove as a client
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteContact()

Result Qmuni::Core::deleteContact ( const int64_t  contact_id)

Delete Contact: removes the contact from the logged in users contact list

Parameters
int64_tcontact_id ID number of the contact to remove from the contact list
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteEmailTemplate()

Result Qmuni::Core::deleteEmailTemplate ( const int64_t  id)

Delete Email Template: deletes the target Email Template for the current app.

Parameters
[in]stringid id of the email template to be deleted
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteEmployee()

Result Qmuni::Core::deleteEmployee ( int64_t  profileID)

Manager required - Delete Employee: Removes the user as an Employee.

Parameters
[in]int64_tprofileID id of the user to remove as an employee
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteMessage()

Result Qmuni::Core::deleteMessage ( const int64_t  message_id)

delete Message: removes a message and all associated content(files, file keys, ect)

Parameters
[in]int64_tmessage_id ID of the conversation this message is a part of
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteParticipant()

Result Qmuni::Core::deleteParticipant ( int64_t  conversation_id,
int64_t  profile_id 
)
Parameters
[in]int64_tconversation_id id of the conversation to add the participant to
[in]int64_tprofile_id id of the profile to add as a participant to the conversation
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteProfileRole()

Result Qmuni::Core::deleteProfileRole ( const int64_t  profileID,
const int64_t  roleID 
)

delete Role from a Profile : removes the Role from the Profile

Parameters
[in]int64_tprofileID - id of the profile to lose the role
[in]int64_troleID - id of the role to tale awau from the profile
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteSMTPHost()

Result Qmuni::Core::deleteSMTPHost ( )

delete SMTP Host: removes the logged in users current SMTP Host settings

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ disable_logging()

void Qmuni::Core::disable_logging ( )

Disable Logging: turns off Logging messages. Logging messages will no longer be written to the log file until it is enabled

◆ editConversation()

Result Qmuni::Core::editConversation ( int64_t  conversation_id,
const string &  subject,
int  hide,
int64_t  hide_until 
)

Edit Conversation: Change the subject and/or hide the conversation

Parameters
[in]int64_tconversation_id ID of the conversation to change
[in]stringsubject What the subject of the conversation should be set to
[in]inthide 1 for hide 0 for unhide
[in]int64_thide_until date to hide the conversation until.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ editEmailTemplate()

Result Qmuni::Core::editEmailTemplate ( const int64_t  id,
const string &  type,
const string &  subject,
const string &  body,
const string &  cc,
const string &  bcc 
)

Edit Email Template: changes the values of an Email Template.

Parameters
[in]int64_tid id for the email template to change
[in]stringtype type of the email template
[in]stringsubject subject for the email template
[in]stringbody body text for the email template
[in]stringcc visible emails will be sent to these emails in this email template
[in]stringbcc hidden emails will be sent to these emails in this email template
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ editMessage()

Result Qmuni::Core::editMessage ( const int64_t  message_id,
const string &  key,
int  value 
)

Edit Message: Change a message's value by key. Mostly used for marking a message as viewed

Parameters
[in]int64_tmessage_id ID of the message to change
[in]stringkey The key of the key value pair to lookup
[in]intvalue the value to set the key to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ editPassword()

Result Qmuni::Core::editPassword ( int64_t  profile_id,
const string &  email,
const string &  new_password,
const string &  old_password 
)

Edit Password: Changes the password of the given profile if old password matches. Requires admin login

Parameters
[in]int64_tprofile_id ProfileID of the profile to change
[in]stringemail email address for the profile to change
[in]stringnew_password the password that should be used in the future
[in]stringold_password the password that is currently used
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ editRecoveredCode()

Result Qmuni::Core::editRecoveredCode ( const string &  email,
const string &  app_token,
const string &  new_code,
const string &  recovery_answer,
const string &  private_key,
const string &  private_key_salt 
)

Edit Recovered Code: sets the matching users password to the one provided if the auth token is valid

Parameters
[in]Stringemail the email address of the user requesting their recovery answer
[in]Stringapp_token the app token of the user requesting their recovery answer
[in]Stringnew_code plain text of the new password to for the user to login with
[in]Stringrecovery_answer plain text of the answer to the recovery question
[in]Stringprivate_key the encrypted private key that is returned by a successful getRecoveryAnswer
[in]Stringprivate_key_salt salt for the encrypted private key that is returned by a successful getRecoveryAnswser
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ editSMTPHost()

Result Qmuni::Core::editSMTPHost ( const string &  host,
const string &  port,
const string &  username,
const string &  password,
const string &  senderName,
const string &  senderEmail 
)

edit SMTP Host: changes the current SMTP host settings to the given parameters

Parameters
[in]stringhost
[in]stringport
[in]stringusername
[in]stringpassword
[in]stringsenderName
[in]stringsenderEmail
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ enable_logging()

void Qmuni::Core::enable_logging ( )

Enable Logging: turns on logging messages. Logging messages will be written to the log file until it is disabled

◆ extractFileNameFromInput()

static string Qmuni::Core::extractFileNameFromInput ( const string &  fileName)
static

◆ getAppAsset() [1/2]

Result Qmuni::Core::getAppAsset ( const string &  app_token)

Get App Asset List: gets a list of all assets for an app

Parameters
[in]stringapp_token The token of the app
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getAppAsset() [2/2]

Result Qmuni::Core::getAppAsset ( const string &  app_token,
const string &  name,
const string &  destination 
)

Get App Asset: gets a specific asset for an app

Parameters
[in]stringapp_token The token of the app
[in]stringname The name of the asset to look it up by
[in]stringdestination The path to where the asset should be downloaded to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getApps()

Result Qmuni::Core::getApps ( )

Get Apps: list all applications the belong the business the logged in user is an admin for. Requires user to be logged in as an admin

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getAppToken()

const string& Qmuni::Core::getAppToken ( ) const

Get App Token: Returns the application token currently in use

Returns
string app_token

◆ getAsset() [1/2]

Result Qmuni::Core::getAsset ( )

Get Asset List: gets a list of all assets for the app the user is currently logged into

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getAsset() [2/2]

Result Qmuni::Core::getAsset ( const string &  name,
const string &  destination 
)

Get Asset: gets a specific asset for the app the user is currently logged into

Parameters
[in]stringname The name of the asset to look it up by
[in]stringdestination The path to where the asset should be downloaded to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getAuditList()

Result Qmuni::Core::getAuditList ( const string &  app_token)

Get Audit List: gets list of all the current audits for the specified app

Parameters
[in]stringappToken - token that specifies which application's audits should be retrieved
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getBaseUri()

static string Qmuni::Core::getBaseUri ( )
static

Get Base URI: returns the base uri string used for all request

Returns
string base uri

◆ getBatchContacts()

Result Qmuni::Core::getBatchContacts ( int64_t  profile_id)

Get Contacts in Batch: Gets list of contacts for a given profile id

Parameters
[in]int64_tprofile_id
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getBusiness()

Result Qmuni::Core::getBusiness ( const string &  setup_token)

◆ getContactList()

Result Qmuni::Core::getContactList ( )

Get Contacts: returns a json array of all contact objects associated with the logged in user.

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getConversation() [1/2]

Result Qmuni::Core::getConversation ( int64_t  id)

Get Conversation with ID: gets details of the specified conversation

Parameters
[in]int64_tconversation_id The ID the conversation trying to be accessed.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getConversation() [2/2]

Result Qmuni::Core::getConversation ( const int64_t &  id,
const map< string, string > &  queryParams 
)

Get Conversation list: returns an array of conversation objects that have at least one message and meet the query parameters.

Parameters
[in]int64_tconversation_id The ID the conversation trying to be accessed and limits the number of messages returned
[in]map<string,string>key value pairs of query parameters.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getConversationList() [1/2]

Result Qmuni::Core::getConversationList ( const string &  start_date,
const string &  end_date 
)

Get Conversation list: returns an array of conversation objects that have at least one message that was created before the given date.

Parameters
[in]stringstart_date A string formatted in YYYY-MM-DDTHH:MM:SS.
[in]stringend_date A string formatted in YYYY-MM-DDTHH:MM:SS.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getConversationList() [2/2]

Result Qmuni::Core::getConversationList ( bool  areHidden,
const map< string, string > &  queryParams 
)

Get Conversation list: returns an array of conversation objects that have at least one message and meet the query parameters.

Parameters
[in]boolareHidden if the returned list is hidden conversations(true) or normal conversations(false)
[in]map<string,string>key value pairs of query parameters.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getCount()

Result Qmuni::Core::getCount ( )

Get Count: Retrieves statistics relevant to the current logged-in user.

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getCountType()

Result Qmuni::Core::getCountType ( const string &  type)

Get Count Type: Asks Qmuni for a count of type given a logged-in user. Supported values for type: new_message

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getEmailTemplate()

Result Qmuni::Core::getEmailTemplate ( const int64_t  id)

Get Email Templates: gets the data for the specific Email Template.

Parameters
[in]stringid id of the email template
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getEmailTemplateList()

Result Qmuni::Core::getEmailTemplateList ( )

Get Email Template List: gets the list of Email Templates for the current app.

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getFile()

Result Qmuni::Core::getFile ( const int64_t  file_id,
const string &  file_name,
const string &  destination 
)

Get File: Downloads a file with the provided file_id. The file is saved to the provided destination which can be relative or absolute and uses the given attachment name to save the file as.

Parameters
[in]int64_tfile_id ID of the attachment
[in]string&file_name name the file should be saved under
[in]string&destination string that is a relative or absolute path to where the file file should be saved to.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getFileList()

Result Qmuni::Core::getFileList ( )

Get Files: returns an array of file objects that describe a file stored on qmuni

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getFileNameFromDisposition()

static string Qmuni::Core::getFileNameFromDisposition ( const string &  disposition)
static

◆ getFilePreview()

Result Qmuni::Core::getFilePreview ( int64_t  file_id,
const string &  file_name,
const string &  destination 
)

Get File: Downloads a file with the provided file_id. The file is saved to the provided destination which can be relative or absolute and uses the given attachment name to save the file as.

Parameters
[in]int64_tfile_id ID of the attachment
[in]string&file_name name the file should be saved under
[in]string&destination string that is a relative or absolute path to where the file file should be saved to.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getFileSimple()

Result Qmuni::Core::getFileSimple ( const int64_t  file_id,
const string &  file_name,
const string &  destination 
)

Get File from qcryptor: Downloads a file with the provided file_id after qcryptor decrypts it. The file is saved to the provided destination which can be relative or absolute and uses the given attachment name to save the file as.

Parameters
[in]int64_tfile_id ID of the attachment
[in]string&file_name name the file should be saved under
[in]string&destination string that is a relative or absolute path to where the file file should be saved to.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getGlobals()

Core* Qmuni::Core::getGlobals ( )

◆ getHiddenConversationList()

Result Qmuni::Core::getHiddenConversationList ( )

Get Hidden Conversations: Retrieves a list of all hidden conversations for the logged in user.

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getHiddenFileList()

Result Qmuni::Core::getHiddenFileList ( )

Get hidden Files: returns an array of file objects marked as hidden that describe a file stored on qmuni

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getHomeDir()

string Qmuni::Core::getHomeDir ( )

Get Home Directory: Returns the absolute path of the home directory for the core library

Returns
string home_dir

◆ getLoginHash()

Result Qmuni::Core::getLoginHash ( const string &  email,
const string &  code,
const string &  app_token 
)

getLoginHash: generates the hash required to login with loginSimple

Parameters
[in]stringemail Email addresss of the account that is trying to be accessed.
[in]stringcode the code of associated with the account that is trying to be accessed
[in]stringapp_token a token that represents which app to login to.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getMessage()

Result Qmuni::Core::getMessage ( int64_t  message_id)

Get Message: Retrieves the message with the given ID.

Parameters
[in]int64_tmessage_id Id of the message to be retrieved.
Returns
int status_code HTML status code of the get message call

◆ getMessageList()

Result Qmuni::Core::getMessageList ( )

Get Messages: returns an array of message objects

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getModifiedConversations()

Result Qmuni::Core::getModifiedConversations ( const int64_t  epochSeconds)

get Modified Conversations: returns a list of conversations that were modifided after the provided date

Parameters
[in]int64_tepochSeconds seconds after epoch for the oldest modifaction to be caputred.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getModifiedList()

Result Qmuni::Core::getModifiedList ( const int64_t  epochSeconds,
const string &  resource 
)

get Modified List: returns a list of the requested resource that were modifided after the provided date

Parameters
[in]int64_tepochSeconds seconds after epoch for the oldest modifaction to be caputred.
[in]stringresource which resource to get modified data of
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getPort()

static string Qmuni::Core::getPort ( )
static

Get Port: Returns the insecure port used when connecting to the Qmuni API

Returns
string port number

◆ getPrivateKey()

Result Qmuni::Core::getPrivateKey ( )

Get Private Key: returns the encrypted private key for the logged in user

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfile() [1/3]

Result Qmuni::Core::getProfile ( const string &  email)

Get Profile: Returns profile details for the profile with the matching email address. Requires manager login

Parameters
[in]stringemail the email address of the profile for the data requested
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfile() [2/3]

Result Qmuni::Core::getProfile ( const int64_t &  profileID)

Get Profile: Returns profile details for the profile with the matching profile id. Requires manager login

Parameters
[in]int64_tprofileID the ID of the profile for the data requested
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfile() [3/3]

Result Qmuni::Core::getProfile ( )

Get Profile: returns a profile object that describes the logged in user

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfileImage()

Result Qmuni::Core::getProfileImage ( int64_t  profile_id,
const string &  file_name,
const string &  path 
)

Get Profile Image: Downloads the profile image file to the path and saves it with the given name

Parameters
int64_tprofile_id ID of the profile who's image should be downloaded
stringfile_name Name the image should be saved as locally
stringpath path to where the file should be saved.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfileRolesList()

Result Qmuni::Core::getProfileRolesList ( )

Get Profile Roles: get list of all roles for the current application

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfilesForRoleList()

Result Qmuni::Core::getProfilesForRoleList ( const int64_t  roleID)

get profile for the role: gets list of all profile that share the role

Parameters
[in]int64_troleID - id of role that all users in the list will share
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProtocol()

static string Qmuni::Core::getProtocol ( )
static

Get API Protocol: returns the current protocol of the API being used

Returns
string API_Protocol

◆ getQID()

const string& Qmuni::Core::getQID ( ) const

Get QmuniID: returns Qmuni session id

Returns
string session_id

◆ getRecoveryAnswer()

Result Qmuni::Core::getRecoveryAnswer ( const string &  email,
const string &  app_token,
const string &  answer 
)

Get Recovery Answer: gets the encrypted recovery answer for the matching email and app token

Parameters
[in]Stringemail the email address of the user requesting their recovery answer
[in]Stringapp_token the app token of the user requesting their recovery answer
[in]Stringanswser answer to the security question
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getRecoveryQuestion() [1/2]

Result Qmuni::Core::getRecoveryQuestion ( )

Get Recovery Question: returns the recovery question for the logged in user

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getRecoveryQuestion() [2/2]

Result Qmuni::Core::getRecoveryQuestion ( const string &  email,
const string &  result 
)

Get Recovery Question: returns the recovery question for matching user

Parameters
[in]Stringemail email address of user to get recovery question and salt
[in]Stringapp_token app token of user to get recovery question and salt
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getRoleList()

Result Qmuni::Core::getRoleList ( )

Get Role List: get list of all roles for the given app

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getSalt()

Result Qmuni::Core::getSalt ( const string &  email,
const string &  app_token 
)

Get Salt: returns the salts required to login

Parameters
[in]stringemail email of the user attempting to login
[in]stringapp_token application token for the app the user is trying to login to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getSecurePort()

static string Qmuni::Core::getSecurePort ( )
static

Get Secure Port: Returns the secure port used when connecting to the Qmuni API

Returns
string port number

◆ getServer()

static string Qmuni::Core::getServer ( )
static

Get Server: Returns the I.P. Address of the server request are being sent to

Returns
string server_address

◆ getSMTPHost()

Result Qmuni::Core::getSMTPHost ( )

get SMTP Host: returns the logged in users current SMTP Host settings

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getVersion()

static string Qmuni::Core::getVersion ( )
static

Get API Version: returns the current version of the API being used

Returns
string API_Version

◆ hideConversation()

Result Qmuni::Core::hideConversation ( int64_t  conversation_id)

Hide Conversation: Sets a conversation's hidden value to 1.

Parameters
[in]int64_tconversation_id ID of the conversation to be hidden.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ hideConversationBatch()

Result Qmuni::Core::hideConversationBatch ( bool  shouldHide,
std::vector< int64_t >  conversation_id 
)

Hide Conversations in Batch: Sets a list of conversations' hidden value.

Parameters
[in]boolshouldHide
[in]vector<int64_t>conversation_ids IDs of the conversations to hide or unhide.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ hideConversationUntil()

Result Qmuni::Core::hideConversationUntil ( int64_t  conversation_id,
const string &  date 
)

Hide Conversation Until: Hides the conversaiton until the specified date

Parameters
[in]int64_tconversation_id ID of the conversation to be hidden.
[in]stringdate The date the conversation will not int64_ter be hidden in UNIX time.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ hideConversationUntilBatch()

Result Qmuni::Core::hideConversationUntilBatch ( std::vector< int64_t >  conversation_id,
const string &  date 
)

Hide Conversations until in Batch: Sets a list of conversations' hidden value.

Parameters
[in]vector<int64_t>conversation_ids IDs of the conversations to hide or unhide.
[in]stringdate The date the conversation will not int64_ter be hidden in UNIX time.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ login()

Result Qmuni::Core::login ( const string &  email,
const string &  code,
const string &  app_token 
)

Login: used to create a session with an App

Parameters
[in]stringemail Email addresss of the account that is trying to be accessed.
[in]stringcode the code of associated with the account that is trying to be accessed
[in]stringapp_token a token that represents which app to login to.
[in]booladmin=false is attempted to login as an admin
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ loginSimple()

Result Qmuni::Core::loginSimple ( const string &  email,
const string &  code,
const string &  app_token 
)

Login Simple: used to create a session with an App. Manipulates the inputs in such a way it can be used with qcryptor

Parameters
[in]stringemail Email addresss of the account that is trying to be accessed.
[in]stringcode the code of associated with the account that is trying to be accessed
[in]stringapp_token a token that represents which app to login to.
[in]booladmin=false is attempted to login as an admin
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ logMessage()

static void Qmuni::Core::logMessage ( const string &  message,
int  logLevel = 8 
)
static

Log Message: writes a message to the log file.

Parameters
stringmessage message to be written to log file
inlogLevel 1-8 level of importance 1 being the most important

◆ logout()

Result Qmuni::Core::logout ( )

Logout: End the session and removes all qmuni stored session data

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ ok()

Result Qmuni::Core::ok ( )

OK: Gets the current session. Recommended to use to check the connection/status of qmuni

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ qcryptorAddProfile()

Result Qmuni::Core::qcryptorAddProfile ( const string &  app_token,
const string &  email,
const string &  code,
const string &  salt1,
const string &  first_name,
const string &  last_name,
const string &  phone 
)
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ qcryptorAddRecoveryQuestion()

Result Qmuni::Core::qcryptorAddRecoveryQuestion ( const string &  question,
const string &  answer,
const string &  salt1 
)

Add Recovery Question with qcryptor: add or replaces the current recovery question for the logged in user

Parameters
[in]Stringquestion the recovery question being added
[in]Stringanswer a sha512 hash of the plain text answer to question
[in]Stringsalt1 the salt used to generate answer
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ qcryptorEditPassword()

Result Qmuni::Core::qcryptorEditPassword ( int64_t  profile_id,
const string &  new_hash1,
const string &  salt1,
const string &  old_hash1,
const string &  old_salt2 
)

Edit Password for qcryptor: Changes the password of the given profile if old password matches. Requires admin login

Parameters
[in]int64_tprofile_id ProfileID of the profile to change
[in]stringnew_hash1 hash1 that should be used in the future
[in]stringsatl1 salt1 for the profile
[in]stringold_hash1 the hash1 that is currently used
[in]stringsatl2 salt2 for the profile
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ qcryptorEditRecoveredCode()

Result Qmuni::Core::qcryptorEditRecoveredCode ( const string &  email,
const string &  app_token,
const string &  new_hash1,
const string &  new_salt1,
const string &  answer_hash1,
const string &  answer_salt2,
const string &  private_key,
const string &  private_key_salt 
)

Edit Recovered Code with qcryptor: sets the matching users password to the one provided if the auth token is valid

Parameters
[in]Stringemail the email address of the user requesting their recovery answer
[in]Stringapp_token the app token of the user requesting their recovery answer
[in]Stringnew_hash1 the new first hash used to log the user into their account
[in]Stringnew_salt1 salt used to hash the new code the first time
[in]Stringanswer_hash1 hash1 of old code
[in]Stringanswer_salt2 the salt used for the second hash of the recovery answer
[in]Stringprivate_key the app token of the user requesting their recovery answer
[in]Stringprivate_key_salt the app token of the user requesting their recovery answer
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ qcryptorGetRecoveryAnswer()

Result Qmuni::Core::qcryptorGetRecoveryAnswer ( const string &  email,
const string &  app_token,
const string &  answer,
const string &  salt1,
const string &  salt2 
)

Get Recovery Answer with qcryptor: gets the encrypted recovery answer for the matching email and app token

Parameters
[in]Stringquestion the recovery question being added
[in]Stringanswer a sha512 hash of the plain text answer to question
[in]Stringsalt1 the salt used to generate answer
[in]Stringsalt2 the second salt used to generate answer
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ qcryptorLogin()

Result Qmuni::Core::qcryptorLogin ( const string &  email,
const string &  hash,
const string &  appToken 
)

Qcryptor Login: used by qcrytor to create a session with an App

Parameters
[in]stringemail Email addresss of the account that is trying to be accessed.
[in]stringhash the code of associated with the account that is trying to be accessed
[in]stringapp_token a token that represents which app to login to.
[in]booladmin=false is attempted to login as an admin
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ requestBusiness()

Result Qmuni::Core::requestBusiness ( const string &  name,
const string &  fname,
const string &  lname,
const string &  email,
const string &  phone 
)

RequestBusiness: Sends contact information to Qmuni to start process of approving business on Qmuni platform

Parameters
[in]stringname business name
[in]stringfirst_name first name of the person responsible for the Qmuni business account
[in]stringlast_name last name of the person responsible for the Qmuni business account
[in]stringemail email address for the person responsible for the Qmuni business account
[in]stringphone phone number for the person responsible for the Qmuni business account
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ sendFile()

Result Qmuni::Core::sendFile ( const string &  path,
const map< string, string > &  file_headers,
std::vector< int64_t >  contacts = std::vector< int64_t >(0) 
)

Send File: Sends a file to the server.

Parameters
[in]stringpath absolute or relative path of the file to be sent.
[in]map<string,string>file_headers http headers to be set for the file transfer
[in]vector<int64_t>contacts contact ids for the file to be sent to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ sendFileSimple()

Result Qmuni::Core::sendFileSimple ( const string &  path,
const map< string, string > &  file_headers 
)

Send File to qcryptor: Sends a file to qcryptor for processing and then sending it to the server.

Parameters
[in]stringpath absolute or relative path of the file to be sent.
[in]map<string,string>file_headers http headers to be set for the file transfer
[in]vector<int64_t>contacts contact ids for the file to be sent to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ sendMessage() [1/2]

Result Qmuni::Core::sendMessage ( int64_t  message_id,
bool  push_notify 
)

Send Message: Sends the message with the given ID.

Parameters
[in]int64_tmessage_id The ID of the message to be sent.
[in]boolpush_notify should send push notification for message
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ sendMessage() [2/2]

Result Qmuni::Core::sendMessage ( int64_t  message_id,
std::vector< int64_t > &  contacts,
bool  push_notify 
)

Send Message to Contacts: Sends the message with the given ID to the provided contacts.

Parameters
[in]int64_tmessage_id The ID of the message to be sent.
[in]vector<int64_t>contacts vector of contact ids of people to receive the message
[in]boolpush_notify should send push notification for message
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ sendMessageSimple()

Result Qmuni::Core::sendMessageSimple ( int64_t  message_id,
bool  push_notify 
)

Send Message to qcryptor: Tells qcryptor to send the message with the given ID

Parameters
[in]int64_tmessage_id The ID of the message to be sent.
[in]boolpush_notify should send push notification for message
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ sendWelcomeEmail() [1/2]

Result Qmuni::Core::sendWelcomeEmail ( const string &  role,
std::vector< int64_t >  profileList 
)

Send Welcome Email: sends a Welcome email to each profile listed with the template associated with the role

Parameters
[in]stringrole the type of welcome email to send
[in]vector<int64_t>profileList list of profiles to receive the welcome email
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ sendWelcomeEmail() [2/2]

Result Qmuni::Core::sendWelcomeEmail ( std::vector< int64_t >  profiles)

Send Welcome Email: Sends a welcome email to each profile

Parameters
[in]vector<int64_t>profiles list of profile ID to send welcome emails to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ setContactID()

void Qmuni::Core::setContactID ( int64_t  contact_id)

◆ setCredentials()

void Qmuni::Core::setCredentials ( const string &  private_key,
const string &  QID,
const string &  appToken 
)

Set user credentials: set user credentials. Used to manage multiple sessions.

Parameters
stringprivate_key unencrypted private key
stringQID session id to be maintained
stringappToken application token for the session

◆ setPort()

void Qmuni::Core::setPort ( const string &  port)

Set Port: Sets the insecure port used when connecting to the Qmuni API

Parameters
stringport port number

◆ setProtocol()

void Qmuni::Core::setProtocol ( const string &  protocol)

Set API Protocol: set the protocol of the api to use.

Parameters
stringversion the protocol of the api to use

◆ setSecurePort()

void Qmuni::Core::setSecurePort ( const string &  securePort)

Set Secure Port: Sets the secure port used when connecting to the Qmuni API

Parameters
stringport port number

◆ setServer()

void Qmuni::Core::setServer ( const string &  server)

Set Server: sets the I.P. Address of the server request are sent to

Parameters
stringserver_address I.P. address request are sent to

◆ setVersion()

void Qmuni::Core::setVersion ( const string &  version)

Set API Version: set the version of the api to use. Doesn't change Core Library behaviors.

Parameters
stringversion the version of the api to use

◆ setWatchers()

Result Qmuni::Core::setWatchers ( const int64_t &  conversationID,
vector< int64_t > &  watcherProfiles,
bool  isWatcher 
)

Set Watchers: set a group of profiles watchere status for a conversation

Parameters
[in]int64_tconversationID the id of the conversation whos participants are changing watcher status
[in]vecto<int64_t>watcherProfiles list of profile ids of the profiles whos watcher status is changing
[in]boolisWatcher if the profiles for the conversation are being set as a watcher or not
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ shareFile() [1/2]

Result Qmuni::Core::shareFile ( int64_t  file_id,
int64_t  contact_id 
)

Share File: sends a file to a contact without the use of a message

Parameters
[in]int64_tfile_id ID of the file to send
[in]int64_tcontact_id ID of the contact to send the file to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ shareFile() [2/2]

Result Qmuni::Core::shareFile ( int64_t  file_id,
std::vector< int64_t >  contacts 
)

Share File: sends a file to contacts without the use of a message

Parameters
[in]int64_tfile_id ID of the file to send to contacts
[in]vector<int64_t>contacts vector of contact IDs to to send the file to.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ toggle_logging()

void Qmuni::Core::toggle_logging ( )

Toggle Logging: Enables or disables logging depending on what the current state is.

◆ unhideConversation()

Result Qmuni::Core::unhideConversation ( int64_t  conversation_id)

Unhide Conversation: make the specified conversation visible

Parameters
[in]int64_tconversation_id ID of the conversation to be unhidden.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateAppAsset() [1/3]

Result Qmuni::Core::updateAppAsset ( const string &  app_token,
const string &  name,
const string &  path,
const map< string, string > &  file_headers 
)

Update App Asset by File: changes to the given asset to the provided file.

Parameters
[in]stringapp_token The token of the app
[in]stringname The name of the asset to look it up by
[in]stringpath The absolute or relative path for the asset to upload
[in]map<string,string>headers HTTP file headers
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateAppAsset() [2/3]

Result Qmuni::Core::updateAppAsset ( const string &  app_token,
const string &  name,
const int64_t  file_id 
)

Update App Asset by File ID: marks a file as an asset then replaces the given asset

Parameters
[in]stringapp_token The token of the app
[in]stringname The name of the asset to look it up by
[in]int64_tfile_id ID of the file to be marked as an asset
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateAppAsset() [3/3]

Result Qmuni::Core::updateAppAsset ( const string &  app_token,
const string &  name,
const string &  data,
const string &  label,
const string &  mime 
)

Update App Asset by JSON: creates a file from json to take the place of the given asset

Parameters
[in]stringapp_token The token of the app
[in]stringname The name of the asset to look it up by
[in]stringdata contents of the file
[in]stringlabel file name to use when downloading the file created
[in]stringmime mime type that describes to file to be created
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateAsset() [1/3]

Result Qmuni::Core::updateAsset ( const string &  name,
const string &  path,
const map< string, string > &  file_headers 
)

Update Asset by File: changes to the given asset to the provided file.

Parameters
[in]stringname The name of the asset to look it up by
[in]stringpath The absolute or relative path for the asset to upload
[in]map<string,string>headers HTTP file headers
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateAsset() [2/3]

Result Qmuni::Core::updateAsset ( const string &  name,
const int64_t  file_id 
)

Update Asset by File ID: marks a file as an asset then replaces the given asset

Parameters
[in]stringname The name of the asset to look it up by
[in]int64_tfile_id ID of the file to be marked as an asset
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateAsset() [3/3]

Result Qmuni::Core::updateAsset ( const string &  name,
const string &  data,
const string &  label,
const string &  mime 
)

Update Asset by JSON: creates a file from json to take the place of the given asset

Parameters
[in]stringname The name of the asset to look it up by
[in]stringdata contents of the file
[in]stringlabel file name to use when downloading the file created
[in]stringmime mime type that describes to file to be created
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateFile()

Result Qmuni::Core::updateFile ( const int64_t  file_id,
const string &  path,
const map< string, string > &  file_headers,
std::vector< int64_t >  contacts = std::vector< int64_t >(0) 
)

Update File: updates the record of a file so that it points to file data

Parameters
[in]int64_tfile_id ID of the file to update
[in]stringpath The absolute or relative path to the file to upload
[in]map<string,string>headers HTTP file headers
[in]vector<int64_t>contacts list of contact IDs to send the file to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateFileQcryptor()

Result Qmuni::Core::updateFileQcryptor ( const int64_t  file_id,
const string &  path,
const map< string, string > &  file_headers,
std::vector< int64_t >  contacts = std::vector< int64_t >(0) 
)

Update File on qcryptor: uploads the file to qcyptor for encryption prior to sending to qmuni and updating the record

Parameters
[in]int64_tfile_id ID of the file to update
[in]stringpath The absolute or relative path to the file to upload
[in]map<string,string>headers HTTP file headers
[in]vector<int64_t>contacts list of contact IDs to send the file to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateHiddenFile()

Result Qmuni::Core::updateHiddenFile ( const int64_t &  file_id,
const bool  shouldHide 
)

Send hidden File: Sends a file to the server and marks it as hidden.

Parameters
[in]stringpath absolute or relative path of the file to be sent.
[in]map<string,string>file_headers http headers to be set for the file transfer
[in]vector<int64_t>contacts contact ids for the file to be sent to
Returns
Result Qmuni result object that contains the returning json and status code of the request Send hidden File to qcryptor: Sends a file to qcryptor for processing, marks it as hidden, and then sends it to the server.
Parameters
[in]stringpath absolute or relative path of the file to be sent.
[in]map<string,string>file_headers http headers to be set for the file transfer
[in]vector<int64_t>contacts contact ids for the file to be sent to
Returns
Result Qmuni result object that contains the returning json and status code of the request update hidden File: Sets a File as either hidden or not hidden
Parameters
[in]int64_tfile_id id of the file to update
[in]booleanshouldHide the hidden state to set the File to
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateProfile()

Result Qmuni::Core::updateProfile ( const string &  key,
const string &  value 
)

Update Profile: Change the value for any key of the logged in profile

Parameters
[in]stringkey Key of the value to change
[in]stringvalue New value for the given key
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ updateProfileImage()

Result Qmuni::Core::updateProfileImage ( const string &  path,
const std::map< std::string, std::string > &  file_headers 
)

Update Profile Image: Change the logged in users profile image

Parameters
[in]stringpath The absolute or relative path to the new profile image
[in]map<string,string>file_headers HTTP file headers
Returns
Result Qmuni result object that contains the returning json and status code of the request


QmuniCoreiOS: QmuniCocoa Class Reference
QmuniCoreiOS
QmuniCocoa Class Reference

#import <QmuniCocoa.h>

Inheritance diagram for QmuniCocoa:

Instance Methods

(void) - getHomeDir
 
(void) - enableLogging
 
(void) - disableLogging
 
(void) - enumTest:level:
 
(void) - qmuniLog:withLevel:successHandler:failureHandler:alwaysHandler:
 
(void) - getBaseUriWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - getProtocolWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - setProtocol:successHandler:failureHandler:alwaysHandler:
 
(void) - getVersionWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - setVersion:successHandler:failureHandler:alwaysHandler:
 
(void) - setServer:successHandler:failureHandler:alwaysHandler:
 
(void) - setPort:successHandler:failureHandler:alwaysHandler:
 
(void) - getQIDWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - getAppsWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - addAppWithTitle:uccessHandler:failureHandler:alwaysHandler:
 
(void) - requestBusinessWithName:FirstName:LastName:Email:Phone:successHandler:failureHandler:alwaysHandler:
 
(void) - addBusinessWithSetupToken:Password:successHandler:failureHandler:alwaysHandler:
 
(void) - addBusinessSimpleWithSetupToken:Code:Salt:successHandler:failureHandler:alwaysHandler:
 
(void) - addProfileWithAppToken:Email:password:successHandler:failureHandler:alwaysHandler:
 
(void) - updateProfileKey:withValue:successHandler:failureHandler:alwaysHandler:
 
(void) - updateProfileImageWithFilePath:andHeaders:successHandler:failureHandler:alwaysHandler:
 
(void) - getProfileWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - deleteClient:successHandler:failureHandler:alwaysHandler:
 
(void) - deleteEmployee:successHandler:failureHandler:alwaysHandler:
 
(void) - editPasswordForProfile:withEmail:newPassword:oldPassword:successHandler:failureHandler:alwaysHandler:
 
(void) - loginWithAppToken:Email:andCode:successHandler:failureHandler:alwaysHandler:
 
(void) - getLoginHashWithAppToken:Email:andCode:successHandler:failureHandler:alwaysHandler:
 
(void) - getSaltFor:withAppToken:successHandler:failureHandler:alwaysHandler:
 
(void) - loginSimpleWithAppToken:Email:andCode:successHandler:failureHandler:alwaysHandler:
 
(void) - logoutWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - qmuniOkWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - getConversationByID:successHandler:failureHandler:alwaysHandler:
 
(void) - getConversationByID:withQueryParameters:successHandler:failureHandler:alwaysHandler:
 
(void) - getConversationList:withQueryParameters:successHandler:failureHandler:alwaysHandler:
 
(void) - getConversationsFromDate:toDate:successHandler:failureHandler:alwaysHandler:
 
(void) - addParticipants:participants:successHandler:failureHandler:alwaysHandler:
 
(void) - deleteParticipants:participants:successHandler:failureHandler:alwaysHandler:
 
(void) - setWatchers:ForConversation:AsWatchers:successHandler:failureHandler:alwaysHandler:
 
(void) - addProfileRole:role:successHandler:failureHandler:alwaysHandler:
 
(void) - getProfilesForRoleList:successHandler:failureHandler:alwaysHandler:
 
(void) - getProfileRolesList:failureHandler:alwaysHandler:
 
(void) - deleteProfileRole:role:successHandler:failureHandler:alwaysHandler:
 
(void) - addConversationWithContact:successHandler:failureHandler:alwaysHandler:
 
(void) - hideConversation:successHandler:failureHandler:alwaysHandler:
 
(void) - hideConversation:until:successHandler:failureHandler:alwaysHandler:
 
(void) - unhideConversation:successHandler:failureHandler:alwaysHandler:
 
(void) - setHide:forConversationBatch:successHandler:failureHandler:alwaysHandler:
 
(void) - hideConversationBatch:Until:successHandler:failureHandler:alwaysHandler:
 
(void) - getHiddenConversations:failureHandler:alwaysHandler:
 
(void) - updateConversationTopic:withTopic:successHandler:failureHandler:alwaysHandler:
 
(void) - getMessage:successHandler:failureHandler:alwaysHandler:
 
(void) - getMessageListWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - addMessageToConversation:withContent:andFiles:successHandler:failureHandler:alwaysHandler:
 
(void) - addMessageToConversation:withContent:withFiles:andForwardTimeLimit:successHandler:failureHandler:alwaysHandler:
 
(void) - addMessageToConversation:withContent:withFiles:list_restrict_time_limit:list_extend_time_limit:forward_restrict_time_limit:successHandler:failureHandler:alwaysHandler:
 
(void) - editMessage:withKey:andValue:successHandler:failureHandler:alwaysHandler:
 
(void) - getRoleListWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - deleteMessage:successHandler:failureHandler:alwaysHandler:
 
(void) - sendMessage:shouldPush:successHandler:failureHandler:alwaysHandler:
 
(void) - sendMessageSimple:shouldPush:successHandler:failureHandler:alwaysHandler:
 
(void) - sendMessage:withContactList:shouldPush:successHandler:failureHandler:alwaysHandler:
 
(void) - addSMTPHost:port:username:password:senderName:senderEmail:successHandler:failureHandler:alwaysHandler:
 
(void) - getSMTPHost:failureHandler:alwaysHandler:
 
(void) - editSMTPHost:port:username:password:senderName:senderEmail:successHandler:failureHandler:alwaysHandler:
 
(void) - deleteSMTPHost:failureHandler:alwaysHandler:
 
(void) - getModifiedConversationsWithin:successHandler:failureHandler:alwaysHandler:
 
(void) - getContactListWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - addContactWithEmail:successHandler:failureHandler:alwaysHandler:
 
(void) - getProfileImageByID:fileName:destination:successHandler:failureHandler:alwaysHandler:
 
(void) - deleteContactByID:successHandler:failureHandler:alwaysHandler:
 
(void) - getCountWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - getCountWithType:successHandler:failureHandler:alwaysHandler:
 
(void) - getFileByID:fileName:destination:headers:successHandler:failureHandler:alwaysHandler:
 
(void) - getFileByIDSimple:fileName:destination:headers:successHandler:failureHandler:alwaysHandler:
 
(void) - getFileListWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - sendFile:headers:successHandler:failureHandler:alwaysHandler:
 
(void) - sendFileSimple:headers:successHandler:failureHandler:alwaysHandler:
 
(void) - updateHiddenFileByID:shouldHide:successHandler:failureHandler:alwaysHandler:
 
(void) - getHiddenFileListWithSuccessHandler:failureHandler:alwaysHandler:
 
(void) - attachFile:toMessage:successHandler:failureHandler:alwaysHandler:
 
(void) - getAsset:toPath:successHandler:failureHandler:alwaysHandler:
 
(void) - getAppAsset:for:successHandler:failureHandler:alwaysHandler:
 
(void) - getAppAsset:for:successHandler:failureHandler:alwaysHandler:
 
(void) - getAuditList:successHandler:failureHandler:alwaysHandler:
 
(void) - addAuditToApp:withTarget:Handler:storage:successHandler:failureHandler:alwaysHandler:
 
(void) - deleteAuditForApp:withID:successHandler:failureHandler:alwaysHandler:
 
(void) - addPushToken:successHandler:failureHandler:alwaysHandler:
 
(void) - registerForNotifications
 

Method Documentation

◆ addAppWithTitle:uccessHandler:failureHandler:alwaysHandler:()

- (void) addAppWithTitle: (NSString *)  title
uccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add App: Creates an Application with the provided title

Parameters
[in]NSStringtitle title for the app to create

◆ addAuditToApp:withTarget:Handler:storage:successHandler:failureHandler:alwaysHandler:()

- (void) addAuditToApp: (NSString *)  appToken
withTarget: (NSString *)  target
Handler: (NSString *)  handler
storage: (NSString *)  storage
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Audit: starts an audit with the given parameters and records the settings.

Parameters
[in]stringappToken token that specifies which application the should be added to
[in]stringtarget the specific thing to be audited
[in]stringhandler - how the audit data is going to be stored
[in]stringstorage - where it is going to be stored
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addBusinessSimpleWithSetupToken:Code:Salt:successHandler:failureHandler:alwaysHandler:()

- (void) addBusinessSimpleWithSetupToken: (NSString *)  setupToken
Code: (NSString *)  code
Salt: (NSString *)  salt
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Business Simple: Creates a qmuni Business after it has been approved. hashes the code and then sends it off.

Parameters
[in]NSStringsetupToken a token that represents which app to add to qmuni.
[in]NSStringcode hashed password that will be used to generate the login code for the business
[in]NSStringsalt salt used to generate the code sent with this request.

◆ addBusinessWithSetupToken:Password:successHandler:failureHandler:alwaysHandler:()

- (void) addBusinessWithSetupToken: (NSString *)  setupToken
Password: (NSString *)  code
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Business: Creates a qmuni Business after it has been approved

Parameters
[in]NSStringsetupToken a token that represents which app to add to qmuni.
[in]NSStringpassword plain text password that qmuni will use to generate the login code for the business

◆ addContactWithEmail:successHandler:failureHandler:alwaysHandler:()

- (void) addContactWithEmail: (NSString *)  email
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Contact: Adds a contact to the current users contact list.

Parameters
[in]NSStringemail address of the user the current user would like to add to their contact list.

◆ addConversationWithContact:successHandler:failureHandler:alwaysHandler:()

- (void) addConversationWithContact: (long)  contact_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Conversations: Creates a conversation with the logged in user and the user in their contact list with the given contact_id [in] long contact_id ID number used to identify a contact in the logged in users contact list

◆ addMessageToConversation:withContent:andFiles:successHandler:failureHandler:alwaysHandler:()

- (void) addMessageToConversation: (long)  conversation_id
withContent: (NSString *)  content
andFiles: (NSArray *)  files_arr
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Message: Creates a message with the given contents in the given conversation.

Parameters
[in]longconversation_id ID of the conversation this message is a part of
[in]NSStringcontent The content of the message being created.
[in]NSArrayfiles_arr list of files by id to be sent with the message

◆ addMessageToConversation:withContent:withFiles:andForwardTimeLimit:successHandler:failureHandler:alwaysHandler:()

- (void) addMessageToConversation: (long)  conversation_id
withContent: (NSString *)  content
withFiles: (NSArray *)  files_arr
andForwardTimeLimit: (int)  time_limit
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Message: Creates a message with the given contents in the given conversation and parameters.

Parameters
[in]longconversation_id ID of the conversation this message is a part of
[in]NSStringcontent The content of the message being created.
[in]NSArrayfiles list of files by id to be sent with the message
[in]intlist_restrict_time_limit time limit in seconds until this message is marked as hidden

◆ addMessageToConversation:withContent:withFiles:list_restrict_time_limit:list_extend_time_limit:forward_restrict_time_limit:successHandler:failureHandler:alwaysHandler:()

- (void) addMessageToConversation: (long)  conversation_id
withContent: (NSString *)  content
withFiles: (NSArray *)  file_arr
list_restrict_time_limit: (int)  list_restrict_time_limit
list_extend_time_limit: (int)  list_extend_time_limit
forward_restrict_time_limit: (int)  forward_restrict_time_limit
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Message: Creates a message with the given contents in the given conversation and parameters.

Parameters
[in]longconversation_id ID of the conversation this message is a part of
[in]NSStringcontent The content of the message being created.
[in]NSArrayfiles list of files by id to be sent with the message
[in]intlist_restrict_time_limit time limit in seconds until this message is marked as hidden
[in]intlist_extend_time_limit_if_forward time in seconds to extend the mark as hidden count down by each time this message is forwarded
[in]intforward_restrict_time_limit time in seconds until this message can no longer be forwarded

◆ addParticipants:participants:successHandler:failureHandler:alwaysHandler:()

- (void) addParticipants: (long)  conversation_id
participants: (long)  profile_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Participants: adds a contact to the conversation

Parameters
[in]NSStringconversation_id ID of the conversation that the contact is being added to
[in]NSStringprofile_id ID of the profile that is being added to the conversation

◆ addProfileRole:role:successHandler:failureHandler:alwaysHandler:()

- (void) addProfileRole: (long)  profile_id
role: (long)  role
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Role to a Profile : gives the Role to the Profile

Parameters
[in]int64_tprofileID - id of the profile that receives the role
[in]int64_troleID - id of the role to give to the profile
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ addProfileWithAppToken:Email:password:successHandler:failureHandler:alwaysHandler:()

- (void) addProfileWithAppToken: (NSString *)  appToken
Email: (NSString *)  email
password: (NSString *)  password
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Profile: Creates a qmuni profile. Manager only

Parameters
[in]NSStringapp_token a token that represents which app to add the profile to.
[in]NSStringemail Email address to associate with the new account
[in]NSStringpassword Password used to login to the new account with

◆ addPushToken:successHandler:failureHandler:alwaysHandler:()

- (void) addPushToken: (NSString *)  token
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Add Push Token: add push token to qmuni to be used to send push notifications

Parameters
[in]NSStringtoken push token generated by the application

◆ addSMTPHost:port:username:password:senderName:senderEmail:successHandler:failureHandler:alwaysHandler:()

- (void) addSMTPHost: (NSString *)  host
port: (NSString *)  port
username: (NSString *)  username
password: (NSString *)  password
senderName: (NSString *)  senderName
senderEmail: (NSString *)  senderEmail
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

add SMTP Host: creates a SMTP host with the given parameters

Parameters
[in]NSStringhost
[in]NSStringport
[in]NSStringusername
[in]NSStringpassword
[in]NSStringsenderName
[in]NSStringsenderEmail

◆ attachFile:toMessage:successHandler:failureHandler:alwaysHandler:()

- (void) attachFile: (long)  file_id
toMessage: (long)  message_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Attach File: Associates a given file id with a given message id.

Parameters
[in]longfile_id ID of the file to associate with the messsage.
[in]longmessage_id ID that is going to host the file.

◆ deleteAuditForApp:withID:successHandler:failureHandler:alwaysHandler:()

- (void) deleteAuditForApp: (NSString *)  appToken
withID: (long)  auditID
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Delete Audit: stops auditing procedure for the given audit

Parameters
[in]appTokentoken that specifies which application's audit belongs to
[in]auditIDid of the audit to stop
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteClient:successHandler:failureHandler:alwaysHandler:()

- (void) deleteClient: (long)  profileID
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Manager required - Delete Client: Removes the user as a Client.

Parameters
[in]int64_tprofileID id of the user to remove as a client

◆ deleteContactByID:successHandler:failureHandler:alwaysHandler:()

- (void) deleteContactByID: (long)  contact_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Delete Contact: removes the contact from the logged in users contact list

Parameters
longcontact_id ID number of the contact to remove from the contact list

◆ deleteEmployee:successHandler:failureHandler:alwaysHandler:()

- (void) deleteEmployee: (long)  profileID
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Manager required - Delete Employee: Removes the user as an Employee.

Parameters
[in]int64_tprofileID id of the user to remove as an employee

◆ deleteMessage:successHandler:failureHandler:alwaysHandler:()

- (void) deleteMessage: (long)  message_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Send Message: Sends the message with the given ID.

Parameters
[in]longmessage_id The ID of the message to be sent.
[in]boolpush_notify should send push notification for message Delete Message: marks a message and all of it associated data(file, file keys, ect) as deleted
[in]longmessage_id ID of the message to be deleted

◆ deleteParticipants:participants:successHandler:failureHandler:alwaysHandler:()

- (void) deleteParticipants: (long)  conversation_id
participants: (long)  profile_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Delete Participants: removes a participant from the conversation

Parameters
[in]NSStringconversation_id ID of the conversation that the contact is being added to
[in]NSStringprofile_id ID of the profile that is being removed from the conversation

◆ deleteProfileRole:role:successHandler:failureHandler:alwaysHandler:()

- (void) deleteProfileRole: (long)  profile_id
role: (long)  role
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

delete Role from a Profile : removes the Role from the Profile

Parameters
[in]int64_tprofileID - id of the profile to lose the role
[in]int64_troleID - id of the role to tale awau from the profile
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ deleteSMTPHost:failureHandler:alwaysHandler:()

- (void) deleteSMTPHost: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

delete SMTP Host: removes the logged in users current SMTP Host settings

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ disableLogging()

- (void) disableLogging

◆ editMessage:withKey:andValue:successHandler:failureHandler:alwaysHandler:()

- (void) editMessage: (long)  message_id
withKey: (NSString *)  key
andValue: (int)  value
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Edit Message: Change a message's value by key. Mostly used for marking a message as viewed

Parameters
[in]longmessage_id ID of the message to change
[in]NSStringkey The key of the key value pair to lookup
[in]intvalue the value to set the key to

◆ editPasswordForProfile:withEmail:newPassword:oldPassword:successHandler:failureHandler:alwaysHandler:()

- (void) editPasswordForProfile: (long)  profile_id
withEmail: (NSString *)  email
newPassword: (NSString *)  new_password
oldPassword: (NSString *)  old_password
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Edit Password: Changes the password of the given profile if old password matches. Manager only

Parameters
[in]longprofile_id ProfileID of the profile to change
[in]NSStringemail email address for the profile to change
[in]NSStringnew_password the password that should be used in the future
[in]NSStringold_password the password that is currently used

◆ editSMTPHost:port:username:password:senderName:senderEmail:successHandler:failureHandler:alwaysHandler:()

- (void) editSMTPHost: (NSString *)  host
port: (NSString *)  port
username: (NSString *)  username
password: (NSString *)  password
senderName: (NSString *)  senderName
senderEmail: (NSString *)  senderEmail
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

edit SMTP Host: changes the current SMTP host settings to the given parameters

Parameters
[in]NSStringhost
[in]NSStringport
[in]NSStringusername
[in]NSStringpassword
[in]NSStringsenderName
[in]NSStringsenderEmail

◆ enableLogging()

- (void) enableLogging

◆ enumTest:level:()

- (void) enumTest: (NSString *)  message
level: (enum QM_LOG_LEVEL level 

◆ getAppAsset:for:successHandler:failureHandler:alwaysHandler:() [1/2]

- (void) getAppAsset: (NSString *)  name
for: (NSString *)  appToken
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Asset: downloads the asset for the app to the applications application support directory

Parameters
[in]NSStringname Name of the asset to get
[in]NSStringappToken App Token of the the app that the desired asset belongs to

◆ getAppAsset:for:successHandler:failureHandler:alwaysHandler:() [2/2]

- (void) getAppAsset: (NSString *)  name
for: (NSString *)  appToken
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Asset: downloads the asset for the app to the applications application support directory

Parameters
[in]NSStringname Name of the asset to get
[in]NSStringappToken App Token of the the app that the desired asset belongs to

◆ getAppsWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getAppsWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Apps: list all applications the belong the business the logged in user is an admin for. Requires user to be logged in as an admin

◆ getAsset:toPath:successHandler:failureHandler:alwaysHandler:()

- (void) getAsset: (NSString *)  name
toPath: (NSString *)  destination
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Asset: Associates a given file id with a given message id.

Parameters
[in]NSStringname Name of the asset to get
[in]NSStringdestination path to directory of where to download asset to

◆ getAuditList:successHandler:failureHandler:alwaysHandler:()

- (void) getAuditList: (NSString *)  appToken
successHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Audit List: gets list of all the current audits for the specified app

Parameters
[in]stringappToken - token that specifies which application's audits should be retrieved
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getBaseUriWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getBaseUriWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Base URI: returns the base uri string used for all request

◆ getContactListWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getContactListWithSuccessHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Contacts: returns a json array of all contact objects associated with the logged in user.

◆ getConversationByID:successHandler:failureHandler:alwaysHandler:()

- (void) getConversationByID: (long)  conversation_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Conversation with ID: gets details of the specified conversation

Parameters
[in]longconversation_id The ID the conversation trying to be accessed.

◆ getConversationByID:withQueryParameters:successHandler:failureHandler:alwaysHandler:()

- (void) getConversationByID: (long)  conversation_id
withQueryParameters: (NSDictionary *)  queryParams
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Conversation with ID: gets details of the specified conversation and limits messages returned based on query parameters

Parameters
[in]longconversation_id The ID the conversation trying to be accessed.
[in]NSDictionaryqueryParams key value pairs of the query parameters and thier value

◆ getConversationList:withQueryParameters:successHandler:failureHandler:alwaysHandler:()

- (void) getConversationList: (Boolean)  areHidden
withQueryParameters: (NSDictionary *)  queryParams
successHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Conversation list with query parameters: list conversations that match the provided query parameters

Parameters
[in]BooleanareHidden list hidden conversations(true) or visable conversations(false)
[in]NSDictionaryqueryParams key value pairs of the query parameters and thier value

◆ getConversationsFromDate:toDate:successHandler:failureHandler:alwaysHandler:()

- (void) getConversationsFromDate: (NSDate *)  start_date
toDate: (NSDate *)  end_date
successHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Conversations by dates: returns an array of conversation objects that have at least one message that was created within the given range.

Parameters
[in]NSDatestart_date the earliest date to search from.
[in]NSDateend_date the lastest date to search to.

◆ getCountWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getCountWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Count: Retrieves statistics relevant to the current logged-in user.

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getCountWithType:successHandler:failureHandler:alwaysHandler:()

- (void) getCountWithType: (NSString *)  type
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Count Type: Asks Qmuni for a count of type given a logged-in user. Supported values for type: new_message

Parameters
[in]NSStringtype the category of the count to retrieve
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getFileByID:fileName:destination:headers:successHandler:failureHandler:alwaysHandler:()

- (void) getFileByID: (long)  file_id
fileName: (NSString *)  file_name
destination: (NSString *)  destination
headers: (NSDictionary *)  headers
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get File: Downloads a file with the provided file_id. The file is saved to the provided destination which can be relative or absolute and uses the given attachment name to save the file as.

Parameters
[in]longfile_id ID of the attachment
[in]NSStringfile_name name the file should be saved under
[in]NSStringdestination NSString that is a relative or absolute path to where the file file should be saved to.

◆ getFileByIDSimple:fileName:destination:headers:successHandler:failureHandler:alwaysHandler:()

- (void) getFileByIDSimple: (long)  file_id
fileName: (NSString *)  file_name
destination: (NSString *)  destination
headers: (NSDictionary *)  headers
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get File from qcryptor: Downloads a file with the provided file_id after qcryptor decrypts it. The file is saved to the provided destination which can be relative or absolute and uses the given attachment name to save the file as.

Parameters
[in]longfile_id ID of the attachment
[in]NSStringfile_name name the file should be saved under
[in]NSStringdestination NSString that is a relative or absolute path to where the file file should be saved to.

◆ getFileListWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getFileListWithSuccessHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Files: returns an array of file objects that describe a file stored on qmuni

◆ getHiddenConversations:failureHandler:alwaysHandler:()

- (void) getHiddenConversations: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Hidden Conversations: Retrieves a list of all hidden conversations for the logged in user.

◆ getHiddenFileListWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getHiddenFileListWithSuccessHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get hidden Files: returns an array of file objects marked as hidden that describe a file stored on qmuni

◆ getHomeDir()

- (void) getHomeDir

◆ getLoginHashWithAppToken:Email:andCode:successHandler:failureHandler:alwaysHandler:()

- (void) getLoginHashWithAppToken: (NSString *)  appToken
Email: (NSString *)  email
andCode: (NSString *)  code
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

getLoginHash: used to generate the hash required to login though qmuniServer

Parameters
[in]NSStringapp_token a token that represents which app to login to.
[in]NSStringemail Email addresss of the account that is trying to be accessed.
[in]NSStringcode the code of associated with the account that is trying to be accessed

◆ getMessage:successHandler:failureHandler:alwaysHandler:()

- (void) getMessage: (long)  message_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Message: Retrieves the message with the given ID.

Parameters
[in]longmessage_id Id of the message to be retrieved.

◆ getMessageListWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getMessageListWithSuccessHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Message List: returns an array of message objects

◆ getModifiedConversationsWithin:successHandler:failureHandler:alwaysHandler:()

- (void) getModifiedConversationsWithin: (long)  epochSeconds
successHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

get Modified Conversations: returns a list of conversations that were modifided after the provided date

Parameters
[in]longepochSeconds seconds after epoch for the oldest modifaction to be caputred.

◆ getProfileImageByID:fileName:destination:successHandler:failureHandler:alwaysHandler:()

- (void) getProfileImageByID: (long)  profile_id
fileName: (NSString *)  file_name
destination: (NSString *)  destination
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Profile Image: Downloads the profile image file to the path and saves it with the given name

Parameters
longprofile_id ID of the profile who's image should be downloaded
NSStringfile_name Name the image should be saved as locally
NSStringdestination path to where the file should be saved.

◆ getProfileRolesList:failureHandler:alwaysHandler:()

- (void) getProfileRolesList: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Profile Roles: get list of all roles for the current application

Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfilesForRoleList:successHandler:failureHandler:alwaysHandler:()

- (void) getProfilesForRoleList: (long)  role
successHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

get profile for the role: gets list of all profile that share the role

Parameters
[in]int64_troleID - id of role that all users in the list will share
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ getProfileWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getProfileWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Profile: returns a profile object that describes the logged in user

◆ getProtocolWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getProtocolWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get API Protocol: returns the current protocol of the API being used

◆ getQIDWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getQIDWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get QmuniID: returns Qmuni session id

◆ getRoleListWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getRoleListWithSuccessHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Get Role List: get list of all roles for the given app

◆ getSaltFor:withAppToken:successHandler:failureHandler:alwaysHandler:()

- (void) getSaltFor: (NSString *)  email
withAppToken: (NSString *)  appToken
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get Salt: gets salts associated with an email that are used to hash the password

Parameters
[in]NSStringemail email of the profile whos salts are needed
[in]NSStringappToken app token that represents which app salts to get

◆ getSMTPHost:failureHandler:alwaysHandler:()

- (void) getSMTPHost: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

get SMTP Host: returns the logged in users current SMTP Host settings

◆ getVersionWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) getVersionWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Get API Version: returns the current version of the API being used

◆ hideConversation:successHandler:failureHandler:alwaysHandler:()

- (void) hideConversation: (long)  conversation_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Hide Conversation: Sets a conversation's hidden value to 1.

Parameters
[in]longconversation_id ID of the conversation to be hidden.

◆ hideConversation:until:successHandler:failureHandler:alwaysHandler:()

- (void) hideConversation: (long)  conversation_id
until: (NSDate *)  reveal_date
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Hide Conversation Until: Hides the conversaiton until the specified date

Parameters
[in]longconversation_id ID of the conversation to be hidden.
[in]NSDatereveal_date The date the conversation will not longer be hidden.

◆ hideConversationBatch:Until:successHandler:failureHandler:alwaysHandler:()

- (void) hideConversationBatch: (NSArray *)  conversationIDs
Until: (NSDate *)  date
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Hide Conversations until in Batch: Sets a list of conversations' hidden value.

Parameters
[in]NSDatedate The date the conversation will be unhidden.
[in]NSArrayconversation_ids IDs of the conversations to hide until.
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ loginSimpleWithAppToken:Email:andCode:successHandler:failureHandler:alwaysHandler:()

- (void) loginSimpleWithAppToken: (NSString *)  appToken
Email: (NSString *)  email
andCode: (NSString *)  code
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Login Simple: used to create a session with an App. Manipulates the inputs in such a way it can be used with qcryptor

Parameters
[in]NSStringapp_token a token that represents which app to login to.
[in]NSStringemail Email addresss of the account that is trying to be accessed.
[in]NSStringcode the code of associated with the account that is trying to be accessed

◆ loginWithAppToken:Email:andCode:successHandler:failureHandler:alwaysHandler:()

- (void) loginWithAppToken: (NSString *)  appToken
Email: (NSString *)  email
andCode: (NSString *)  code
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Login: used to create a session with an App

Parameters
[in]NSStringapp_token a token that represents which app to login to.
[in]NSStringemail Email addresss of the account that is trying to be accessed.
[in]NSStringcode the code of associated with the account that is trying to be accessed

◆ logoutWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) logoutWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Logout: End the session and removes all qmuni stored session data

◆ qmuniLog:withLevel:successHandler:failureHandler:alwaysHandler:()

- (void) qmuniLog: (NSString *)  message
withLevel: (enum QM_LOG_LEVEL level
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

◆ qmuniOkWithSuccessHandler:failureHandler:alwaysHandler:()

- (void) qmuniOkWithSuccessHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

OK: Gets the current session. Recommended to use to check the connection/status of qmuni

◆ registerForNotifications()

- (void) registerForNotifications

◆ requestBusinessWithName:FirstName:LastName:Email:Phone:successHandler:failureHandler:alwaysHandler:()

- (void) requestBusinessWithName: (NSString *)  name
FirstName: (NSString *)  firstName
LastName: (NSString *)  lastName
Email: (NSString *)  email
Phone: (NSString *)  phone
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

RequestBusiness: Sends contact information to Qmuni to start process of approving business on Qmuni platform

Parameters
[in]NSStringname business name
[in]NSStringfirstName first name of the person responsible for the Qmuni business account
[in]NSStringlastName last name of the person responsible for the Qmuni business account
[in]NSStringemail email address for the person responsible for the Qmuni business account
[in]NSStringphone phone number for the person responsible for the Qmuni business account
Returns
Result Qmuni result object that contains the returning json and status code of the request

◆ sendFile:headers:successHandler:failureHandler:alwaysHandler:()

- (void) sendFile: (NSString *)  file_path
headers: (NSDictionary *)  headers
successHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Send File: Sends a file to the server.

Parameters
[in]NSStringfile_path absolute or relative path of the file to be sent.
[in]NSDictionaryheaders http headers to be set for the file transfer

◆ sendFileSimple:headers:successHandler:failureHandler:alwaysHandler:()

- (void) sendFileSimple: (NSString *)  file_path
headers: (NSDictionary *)  headers
successHandler: (CollectionBlockHandler success
failureHandler: (CollectionBlockHandler failure
alwaysHandler: (CollectionBlockHandler always 

Send File to qcryptor: Sends a file to qcryptor for processing and then sending it to the server.

Parameters
[in]NSStringfile_path absolute or relative path of the file to be sent.
[in]NSDictionaryheaders http headers to be set for the file transfer

◆ sendMessage:shouldPush:successHandler:failureHandler:alwaysHandler:()

- (void) sendMessage: (long)  message_id
shouldPush: (BOOL)  token
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

◆ sendMessage:withContactList:shouldPush:successHandler:failureHandler:alwaysHandler:()

- (void) sendMessage: (long)  message_id
withContactList: (NSArray *)  contacts
shouldPush: (BOOL)  token
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Send Message to Contacts: Sends the message with the given ID to the provided contacts.

Parameters
[in]longmessage_id The ID of the message to be sent.
[in]NSArraycontacts array of contact ids of people to receive the message
[in]boolpush_notify should send push notification for message

◆ sendMessageSimple:shouldPush:successHandler:failureHandler:alwaysHandler:()

- (void) sendMessageSimple: (long)  message_id
shouldPush: (BOOL)  token
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Send Message to qcryptor: Tells qcryptor to send the message with the given ID

Parameters
[in]longmessage_id The ID of the message to be sent.
[in]boolpush_notify should send push notification for message

◆ setHide:forConversationBatch:successHandler:failureHandler:alwaysHandler:()

- (void) setHide: (BOOL)  shouldHide
forConversationBatch: (NSArray *)  conversationIDs
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Hide Conversations in Batch: Sets a list of conversations' hidden value.

Parameters
[in]boolshouldHide if the conversations should be set to hidden(true) or unhidden(false)
[in]NSArrayconversationIDs IDs of the conversations to hide or unhide.

◆ setPort:successHandler:failureHandler:alwaysHandler:()

- (void) setPort: (NSString *)  port
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Set Port: sets the port to communicate on

◆ setProtocol:successHandler:failureHandler:alwaysHandler:()

- (void) setProtocol: (NSString *)  protocol
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Set API Protocol: set the protocol of the api to use. Doesn't change Core Library behaviors

◆ setServer:successHandler:failureHandler:alwaysHandler:()

- (void) setServer: (NSString *)  server
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Set Server: sets the I.P. Address of the server request are sent to

◆ setVersion:successHandler:failureHandler:alwaysHandler:()

- (void) setVersion: (NSString *)  version
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Set API Version: set the version of the api to use. Doesn't change Core Library behaviors

◆ setWatchers:ForConversation:AsWatchers:successHandler:failureHandler:alwaysHandler:()

- (void) setWatchers: (NSArray *)  watchers
ForConversation: (long)  conversationID
AsWatchers: (BOOL)  isWatcher
successHandler: (BlockHandler success
failureHandler: (BlockHandler failureHandler
alwaysHandler: (BlockHandler alwaysHandler 

Set Watchers: set a group of profiles watchere status for a conversation

Parameters
[in]NSArraywatchers list of profile ids of the profiles whos watcher status is changing
[in]longconversationID the id of the conversation whos participants are changing watcher status
[in]BOOLisWatcher if the profiles for the conversation are being set as a watcher or not

◆ unhideConversation:successHandler:failureHandler:alwaysHandler:()

- (void) unhideConversation: (long)  conversation_id
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Unhide Conversation: make the specified conversation visible

Parameters
[in]longconversation_id ID of the conversation to be unhidden.

◆ updateConversationTopic:withTopic:successHandler:failureHandler:alwaysHandler:()

- (void) updateConversationTopic: (long)  conversation_id
withTopic: (NSString *)  topic
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

update Conversation topic: Change the topic of the conversation

Parameters
[in]longconversation_id ID of the conversation to change
[in]NSStringtopic What the subject of the conversation should be set to

◆ updateHiddenFileByID:shouldHide:successHandler:failureHandler:alwaysHandler:()

- (void) updateHiddenFileByID: (long)  file_id
shouldHide: (Boolean)  shouldHide
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

update hidden File: Sets a File as either hidden or not hidden

Parameters
[in]longfile_id id of the file to update
[in]booleanshouldHide the hidden state to set the File to

◆ updateProfileImageWithFilePath:andHeaders:successHandler:failureHandler:alwaysHandler:()

- (void) updateProfileImageWithFilePath: (NSString *)  path
andHeaders: (NSDictionary *)  headers
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Update Profile Image: Change the logged in users profile image

Parameters
[in]NSStringpath The absolute or relative path to the new profile image
[in]NSDictionaryheaders HTTP file headers

◆ updateProfileKey:withValue:successHandler:failureHandler:alwaysHandler:()

- (void) updateProfileKey: (NSString *)  key
withValue: (NSString *)  value
successHandler: (BlockHandler success
failureHandler: (BlockHandler failure
alwaysHandler: (BlockHandler always 

Update Profile: Change the value for any key of the logged in profile

Parameters
[in]NSStringkey Key of the value to change
[in]NSStringvalue New value for the given key


QmuniCore4D: /Users/c/git/qmuni_4d/src/4DPlugin.h File Reference
QmuniCore4D
4DPlugin.h File Reference

Go to the source code of this file.

Functions

void InitPlugin ()
 
void DeinitPlugin ()
 
void qEnableLogging (sLONG_PTR *pResult, PackagePtr pParams)
 
void qDisableLogging (sLONG_PTR *pResult, PackagePtr pParams)
 
void qSetServer (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniSetPort (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddApp (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddBusiness (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetAppList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetBusiness (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniRequestBusiness (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddEmailTemplate (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddRoledEmailTemplate (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetEmailTemplate (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniEditEmailTemplate (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetEmailTemplateList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteEmailTemplate (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniSendWelcomeEmail (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniLogin (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniLoginSimple (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetLoginHash (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniLogout (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniOk (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetConversation (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetConversationList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetConversationsBefore (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetConversationsAfter (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetConversationsBetween (sLONG_PTR *pResult, PackagePtr pParams)
 
void qGetConversationsStartingAt (sLONG_PTR *pResult, PackagePtr pParams)
 
void qGetConversationsEndingAt (sLONG_PTR *pResult, PackagePtr pParams)
 
void qGetConversationsWithinDate (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetConversationsByIndex (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniEditConversationSubject (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetCount (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetCountType (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddParticipant (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteParticipant (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniSetWatchers (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddProfileRole (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetProfilesForRoleList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetProfileRolesList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteProfileRole (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetHiddenConversations (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniHideConversation (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniHideConversationUntil (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniHideConversationBatch (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniHideConversationUntilBatch (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniUnhideConversation (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetContactList (sLONG_PTR *pResult, PackagePtr pPrams)
 
void qmuniAddContact (sLONG_PTR *pResult, PackagePtr pPrams)
 
void qmuniGetProfileImage (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteContact (sLONG_PTR *pResult, PackagePtr pPrams)
 
void qmuniGetMessage (sLONG_PTR *pResult, PackagePtr pPrams)
 
void qmuniGetMessageList (sLONG_PTR *pResult, PackagePtr pPrams)
 
void qmuniGetConversationMessages (sLONG_PTR *pResult, PackagePtr pPrams)
 
void qmuniAddConversation (sLONG_PTR *pResult, PackagePtr pPrams)
 
void qmuniAddMessage (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddMessageWithFTL (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddMessageWithTamp (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteMessage (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniSendMessage (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniSendMessageToContacts (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetModifiedConversations (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniEditMessage (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetRoleList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddSMTPHost (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetSMTPHost (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniEditSMTPHost (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteSMTPHost (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddProfile (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddTypedProfile (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteClient (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteEmployee (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetProfile (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniUpdateProfile (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniUpdateProfileImage (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniEditPassword (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniSendFile (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetFileList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetFile (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniUpdateHiddenFile (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetHiddenFileList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddPushtoken (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniLog (sLONG_PTR *pResult, PackagePtr pParams)
 
void getHomeDir (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniGetAuditList (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniAddAudit (sLONG_PTR *pResult, PackagePtr pParams)
 
void qmuniDeleteAudit (sLONG_PTR *pResult, PackagePtr pParams)
 
std::string to_string (C_TEXT &text)
 

Function Documentation

◆ DeinitPlugin()

void DeinitPlugin ( )

◆ getHomeDir()

void getHomeDir ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

returns the path of the home directory(defalut location for the log file) TEXT the home directory of the device qmuni is on

◆ InitPlugin()

void InitPlugin ( )

◆ qDisableLogging()

void qDisableLogging ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

◆ qEnableLogging()

void qEnableLogging ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

◆ qGetConversationsEndingAt()

void qGetConversationsEndingAt ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Takes an end date and time and outputs the json of all the conversations that contain a message before the given date and time.

Parameters
[in]DATEdate End Date
[in]TIMEtime End time
[out]TEXTmodel Json that is an array of conversations that contain at least on message that was created before the given date and time
Returns
INTEGER HTML status code

◆ qGetConversationsStartingAt()

void qGetConversationsStartingAt ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Takes a start date and time outputs the json of all the conversations who contain a message starting from the given date and time.

Parameters
[in]DATEdate Start date
[in]TIMEtime Start time
[out]TEXTmodel Json that is an array of conversations that contain at least on message that was created starting from the given dates and times
Returns
INTEGER HTML status code

◆ qGetConversationsWithinDate()

void qGetConversationsWithinDate ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Takes a start date and time and an end date and time and outputs the json of all the conversations who contain a message between those dates and times.

Parameters
[in]DATEstarDate Start date
[in]TIMEstartTime Start time
[in]DATEendDateEnd Date
[in]TIMEendTimeEnd time
[out]TEXTmodel Json that is an array of conversations that contain at least on message that was created between the given dates and times
Returns
INTEGER HTML status code

◆ qmuniAddApp()

void qmuniAddApp ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Adds an application to the account with the given title

Parameters
[in]TEXTtitle title of the application to add
[out]TEXTmodel Resulting json
Returns
INTEGER HTML status code

◆ qmuniAddAudit()

void qmuniAddAudit ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Add Audit: starts an audit with the given parameters and records the settings.

Parameters
[in]TEXTappToken token that specifies which application the should be added to
[in]TEXTtarget the specific thing to be audited
[in]TEXThandler - how the audit data is going to be stored
[in]TEXTstorage - where it is going to be stored
[out]TEXTmodel Json that contains the result of adding the token
Returns
INTEGER HTML status code

◆ qmuniAddBusiness()

void qmuniAddBusiness ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Adds a business to qmuni after the business request has been approved

Parameters
[in]TEXTsetupToken setup token given to the user after thier business has been approved
[in]TEXTcode password sign into the business account with
[out]TEXTmodel Resulting json
Returns
INTEGER HTML status code

◆ qmuniAddContact()

void qmuniAddContact ( sLONG_PTR *  pResult,
PackagePtr  pPrams 
)

Adds a contact to the logged in users contacts.

Parameters
[in]TEXTemail The email address the user that is to be added to contacts.
[out]TEXTmodel Json that contains nothing
Returns
INTEGER HTML status code

◆ qmuniAddConversation()

void qmuniAddConversation ( sLONG_PTR *  pResult,
PackagePtr  pPrams 
)

Creates a conversation between the logged in user and another user.

Parameters
[in]INTEGERuser_id ID of the recipient of the conversation being created by the logged in user.
[out]TEXTmodel Json that contains the contact the conversation was created with and the conversation id
Returns
INTEGER HTML status code

◆ qmuniAddEmailTemplate()

void qmuniAddEmailTemplate ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Add Email Template: adds an email template

Parameters
[in]TEXTtype type of the email template
[in]TEXTsubject subject for the email template
[in]TEXTbody body text for the email template
[in]TEXTcc visible emails will be sent to these emails in this email template
[in]TEXTbcc hidden emails will be sent to these emails in this email template
[out]TEXTjson Response json for the request

◆ qmuniAddMessage()

void qmuniAddMessage ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Creates a message for a given conversation with a given content.

Parameters
[in]LONGINTconversation_id ID of the conversation this message is going to be a part of.
[in]TEXTcontent Content of the message to be created.
[in]ARRAY_LONGINTfiles Array of file ids to be attached to the website
[out]TEXTmodel Json that contains the message id, conversation id, forward time limit and number of forwards
Returns
INTEGER HTML status code

◆ qmuniAddMessageWithFTL()

void qmuniAddMessageWithFTL ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Creates a message for a conversation and sets the forward time limit

Parameters
[in]LONGINTconversation_id ID of the conversation this message is going to be a part of.
[in]TEXTcontent Content of the message to be created.
[in]ARRAY_LONGINTfiles Array of file ids to be attached to the website
[in]intforward_time_limit The duration in seconds that the message can be forwarded. 0 is no limit
[out]TEXTmodel Json that contains message id, conversation id, forward time limit and number of forwards
Returns
INTEGER HTML status code

◆ qmuniAddMessageWithTamp()

void qmuniAddMessageWithTamp ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Creates a message for a conversation and sets all the tamp settings

Parameters
[in]LONGINTconversation_id ID of the conversation this message is going to be a part of.
[in]TEXTcontent Content of the message to be created.
[in]ARRAY_LONGINTfiles Array of file ids to be attached to the website
[in]INTEGERlist_restrict_time_limit how long until a this message can't be listed by anyone
[in]INTEGERlist_extend_time_limit_if_forward extend list_restrict_time_limit by forward_restrict_time_limit if the message was forwareded
[in]INTEGERforward_restrict_time_limit how long to extend the list_restrict_time_lmit
[out]TEXTmodel Json that contains message id, conversation id, forward time limit and number of forwards
Returns
INTEGER HTML status code

◆ qmuniAddParticipant()

void qmuniAddParticipant ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Adds the given profile to the given conversation

Parameters
[in]LONGINTconversationID Conversation id
[in]LONGINTprofileID Profile id
[out]TEXTmodel Json of that contains the updated ??
Returns
INTEGER HTML status code

◆ qmuniAddProfile()

void qmuniAddProfile ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Adds a profile to qmuni.

Parameters
[in]TEXTappToken the qmuni application token for the application to add a profile to,
[in]TEXTemail Email of the user to used for the new profile.
[in]TEXTpassword the password the user will use to login to the account
[out]TEXTmodel Json that contains all the profile default settings
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniAddProfileRole()

void qmuniAddProfileRole ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Add Role to a Profile : gives the Role to the Profile

Parameters
[in]LONGINTprofileID - id of the profile that receives the role
[in]LONGINTroleID - id of the role to give to the profile
[out]TEXTmodel contains returned data
Returns
INTEGER HTML status code

◆ qmuniAddPushtoken()

void qmuniAddPushtoken ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Adds ios push token so that qmuni can send push notifications along with its messages

Parameters
[in]TEXTpush_token The push token
[out]TEXTmodel Json that contains the result of adding the token
Returns
INTEGER HTML status code

◆ qmuniAddRoledEmailTemplate()

void qmuniAddRoledEmailTemplate ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Add Email Template: adds an email template

Parameters
[in]TEXTrole the profile role the template will apply to
[in]TEXTtype type of the email template
[in]TEXTsubject subject for the email template
[in]TEXTbody body text for the email template
[in]TEXTcc visible emails will be sent to these emails in this email template
[in]TEXTbcc hidden emails will be sent to these emails in this email template
[out]TEXTjson Response json for the request

◆ qmuniAddSMTPHost()

void qmuniAddSMTPHost ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

add SMTP Host: creates a SMTP host with the given parameters

Parameters
[in]TEXThost
[in]TEXTport
[in]TEXTusername
[in]TEXTpassword
[in]TEXTsenderName
[in]TEXTsenderEmail
[out]TEXTmodel Json that contains all the profile default settings
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniAddTypedProfile()

void qmuniAddTypedProfile ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Adds a profile to qmuni then sets it to a type of profile.

Parameters
[in]TEXTappToken the qmuni application token for the application to add a profile to,
[in]TEXTemail Email of the user to used for the new profile.
[in]TEXTpassword the password the user will use to login to the account
[in]TEXTtype type of profile (client, employee, ect)
[out]TEXTmodel Json that contains all the profile default settings
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniDeleteAudit()

void qmuniDeleteAudit ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Delete Audit: stops auditing procedure for the given audit

Parameters
[in]TEXTappToken token that specifies which application's audit belongs to
[in]LONGINTauditID id of the audit to stop
[out]TEXTmodel Json that contains the result of adding the token
Returns
INTEGER HTML status code

◆ qmuniDeleteClient()

void qmuniDeleteClient ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Manager required - Delete Client: Removes the user as a Client.

Parameters
[in]LONGINTProfileID ID of the profile to remove from the Client list
[out]TEXTmodel Json that contains all the profile default settings
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniDeleteContact()

void qmuniDeleteContact ( sLONG_PTR *  pResult,
PackagePtr  pPrams 
)

Retrives the json of a specfic message.

Parameters
[in]LONGINTmessage_id The id of the message to be retrieved.
[out]TEXTmodel Json of the retrieved message
Returns
INTEGER HTML status code Deletes the contact with the given id from the users contact list.
Parameters
[in]LONGINTcontact_id
[out]TEXTmodel Json response of deleting contact INTGER HTML status code

◆ qmuniDeleteEmailTemplate()

void qmuniDeleteEmailTemplate ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Delete Email Template: deletes the target Email Template for the current app.

Parameters
[in]LONGINTid id of the email template to be deleted
[out]TEXTjson Response json for the request

◆ qmuniDeleteEmployee()

void qmuniDeleteEmployee ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Manager required - Delete Employee: Removes the user as an Employee.

Parameters
[in]LONGINTProfileID ID of the profile to remove from the Employee list
[out]TEXTmodel Json that contains all the profile default settings
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniDeleteMessage()

void qmuniDeleteMessage ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

marks a message deleted and all of its associated data (files, file keys, ect)

Parameters
[in]LONGINTmessage_id ID of the message to be deleted
[out]TEXTmodel Json that contains the message id, conversation id, forward time limit and number of forwards
Returns
INTEGER HTML status code

◆ qmuniDeleteParticipant()

void qmuniDeleteParticipant ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Removes the given profile from the given conversation

Parameters
[in]LONGINTconversationID Conversation id
[in]LONGINTprofileID Profile id
[out]TEXTmodel Json of that contains the updated ??
Returns
INTEGER HTML status code

◆ qmuniDeleteProfileRole()

void qmuniDeleteProfileRole ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

delete Role from a Profile : removes the Role from the Profile

Parameters
[in]LONGINTprofileID - id of the profile to lose the role
[in]LONGINTroleID - id of the role to tale awau from the profile
[out]TEXTmodel contains returned data
Returns
INTEGER HTML status code

◆ qmuniDeleteSMTPHost()

void qmuniDeleteSMTPHost ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

delete SMTP Host: removes the logged in users current SMTP Host settings

Parameters
[out]TEXTmodel Json that contains all the profile default settings
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniEditConversationSubject()

void qmuniEditConversationSubject ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Takes a start date and time and an end date and time and outputs the json of all the conversations who contain a message between those dates and times.

Parameters
[in]LONGINTconversation_id Conversation id
[in]TEXTsubject Subject
[out]TEXTmodel Json of that contains the updated conversation's conversation id
Returns
INTEGER HTML status code

◆ qmuniEditEmailTemplate()

void qmuniEditEmailTemplate ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Edit Email Template: changes the values of an Email Template.

Parameters
[in]LONGINTid id for the email template to change
[in]TEXTtype type of the email template
[in]TEXTsubject subject for the email template
[in]TEXTbody body text for the email template
[in]TEXTcc visible emails will be sent to these emails in this email template
[in]TEXTbcc hidden emails will be sent to these emails in this email template
[out]TEXTjson Response json for the request

◆ qmuniEditMessage()

void qmuniEditMessage ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Adds the given contact to the given conversation

Parameters
[in]LONGINTmessage_id
[in]TEXTkey
[in]INTEGERvalue
[out]TEXTmodel Json of that contains the updated ??
Returns
INTEGER HTML status code

◆ qmuniEditPassword()

void qmuniEditPassword ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

changess the given users password to the the provied password

Parameters
[in]LONGINTprofile id of user to update password.
[in]TEXTemail email address of user.
[in]TEXTnewPassword updated password.
[in]TEXToldPassword current password.
[out]TEXTmodel Json that contains ??
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniEditSMTPHost()

void qmuniEditSMTPHost ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

edit SMTP Host: changes the current SMTP host settings to the given parameters

Parameters
[in]TEXThost
[in]TEXTport
[in]TEXTusername
[in]TEXTpassword
[in]TEXTsenderName
[in]TEXTsenderEmail
[out]TEXTmodel Json that contains all the profile default settings
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniGetAppList()

void qmuniGetAppList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Gets a list of apps owned by the business

Parameters
[out]TEXTmodel Resulting json
Returns
INTEGER HTML status code

◆ qmuniGetAuditList()

void qmuniGetAuditList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Get Audit List: gets list of all the current audits for the specified app

Parameters
[in]TEXTappToken - token that specifies which application's audits should be retrieved
[out]TEXTmodel Json that contains the result of adding the token
Returns
INTEGER HTML status code

◆ qmuniGetBusiness()

void qmuniGetBusiness ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Gets the approval status of the pending business request

Parameters
[in]TEXTsetupToken setup token sent to the business after they are approved
[out]TEXTmodel Resulting json
Returns
INTEGER HTML status code

◆ qmuniGetContactList()

void qmuniGetContactList ( sLONG_PTR *  pResult,
PackagePtr  pPrams 
)

Retrieves a list of all contacts related to the user currently logged in.

Parameters
[out]TEXTmodel Json array of contacts for the user currently logged in
Returns
INTEGER HTML status code

◆ qmuniGetConversation()

void qmuniGetConversation ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Retrieves the json for a specific conversation.

Parameters
[in]INTEGERconversation_id The ID number of the specific conversation to be retrieved.
[out]TEXTmodel Json of the conversation with the matching ID
Returns
INTEGER HTML status code

◆ qmuniGetConversationList()

void qmuniGetConversationList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

list all the conversations of the current user.

Parameters
[out]TEXTmodel json of a list of all conversation summaries
Returns
INTEGER HTML status code

◆ qmuniGetConversationMessages()

void qmuniGetConversationMessages ( sLONG_PTR *  pResult,
PackagePtr  pPrams 
)

Retrieves a limited list of messages from a conversation that start at an index

Parameters
[in]LONGINTconversation_id id of the conversation whos messages are to be retrived
[in]INTEGERstart the index of the first message to get
[in]INTEGERlimtit the number of conversations to get starting from the start param
[out]TEXTmodel Json that is an array of conversations that meet the query parameters given
Returns
INTEGER HTML status code

◆ qmuniGetConversationsAfter()

void qmuniGetConversationsAfter ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Retrieves a list of conversations that have at least once message that was created after the given date.

Parameters
[in]TEXTafter_date takes DATE converted to TEXT or a TEXT that has a date formatted YYYY-MM-DDTHH:MM:SS.
[out]TEXTmodel Json that is an array of conversations that contain at least one message that was created after the given date
Returns
INTEGER HTML status code

◆ qmuniGetConversationsBefore()

void qmuniGetConversationsBefore ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Retrieves a list of conversations that have at least once message that was created before the given date.

Parameters
[in]TEXTbefore_date takes DATE converted to TEXT or a TEXT that has a date formatted YYYY-MM-DDTHH:MM:SS.
[out]TEXTmodel Json that is an array of conversations that contain at least one message that was created before the given date
Returns
INTEGER HTML status code

◆ qmuniGetConversationsBetween()

void qmuniGetConversationsBetween ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Retrieves a list of conversations that have at least one message between the given dates.

Parameters
[in]TEXTafter_date takes DATE converted to TEXT or a TEXT that has a date formatted YYYY-MM-DDTHH:MM:SS.
[in]TEXTbefore_date takes DATE converted to TEXT or a TEXT that has a date formatted YYYY-MM-DDTHH:MM:SS.
[out]TEXTmodel Json that is an array of conversations that contain at least one message that was created between the given dates
Returns
INTEGER HTML status code

◆ qmuniGetConversationsByIndex()

void qmuniGetConversationsByIndex ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Retrieves a limited list of conversations that start at the given index

Parameters
[in]INTEGERhidden 1 or 0 if querying for hidden conversations or not
[in]INTEGERstart the index of the first conversation to get
[in]INTEGERlimtit the number of conversations to get starting from the start param
[out]TEXTmodel Json that is an array of conversations that meet the query parameters given
Returns
INTEGER HTML status code

◆ qmuniGetCount()

void qmuniGetCount ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)
Parameters
[out]TEXTmodel Json object which contains all available countable type
Returns
INTEGER HTML status code

◆ qmuniGetCountType()

void qmuniGetCountType ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)
Parameters
[in]TEXTtype The type of count to request. Supports: new_message
[out]TEXTmodel Json which contains the count requested
Returns
INTEGER HTML status code

◆ qmuniGetEmailTemplate()

void qmuniGetEmailTemplate ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Get Email Templates: gets the data for the specific Email Template.

Parameters
[in]LONGINTid id of the email template
[out]TEXTjson Response json for the request

◆ qmuniGetEmailTemplateList()

void qmuniGetEmailTemplateList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Get Email Template List: gets the list of Email Templates for the current app.

Parameters
[out]TEXTjson Response json for the request

◆ qmuniGetFile()

void qmuniGetFile ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)
Parameters
[in]LONGINTfile_id to download
[in]TEXTname name to save the file as
[in]TEXTpath Absolute or relitive path for where to save the file to
[out]TEXTmodel Json that contains a report of any erros that occured when trying to download the attachment
Returns
INTEGER HTML status code

◆ qmuniGetFileList()

void qmuniGetFileList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

returns a json array of each file object

Parameters
[out]TEXTmodel Json that contains each file name, mime type, size, path to file on server, and file id
Returns
INTEGER status_code HTML status code of the send file request

◆ qmuniGetHiddenConversations()

void qmuniGetHiddenConversations ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Retrieves a list of all conversations that were hidden.

Parameters
[out]TEXTmodel Json array of the all of the conversations that are hidden for the logged in user
Returns
INTEGER HTML status code

◆ qmuniGetHiddenFileList()

void qmuniGetHiddenFileList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

returns a json array of each file object marked as hidden

Parameters
[out]TEXTmodel Json that contains each file name, mime type, size, path to file on server, and file id
Returns
INTEGER status_code HTML status code of the send file request

◆ qmuniGetLoginHash()

void qmuniGetLoginHash ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Generates the hash required by qcryptor to login to qmuni

Parameters
[in]TEXTappToken the qmuni application token for the application to login to,
[in]TEXTemail the email address of the user attempting to login,
[in]TEXTcode the code of associated with email address for the login attempt.
[out]TEXTsession_token Qmuni session token.
Returns
INTEGER HTML status code

◆ qmuniGetMessage()

void qmuniGetMessage ( sLONG_PTR *  pResult,
PackagePtr  pPrams 
)

Gets the json data of the specified message

Parameters
[in]LONGINTmessag_id
[out]TEXTmodel Json that will contain the message data
Returns
INTEGER HTML status code

◆ qmuniGetMessageList()

void qmuniGetMessageList ( sLONG_PTR *  pResult,
PackagePtr  pPrams 
)

Returns the list of all messages for the current user

Parameters
[out]TEXTmodel Json that will contain the message list
Returns
INTEGER HTML status code

◆ qmuniGetModifiedConversations()

void qmuniGetModifiedConversations ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

get Modified Conversations: returns a list of conversations that were modifided after the provided date

Parameters
[in]LONGINTseconds epochSeconds seconds after epoch for the oldest modifaction to be caputred.
[out]TEXTmodel Json that contains nothing
Returns
INTEGER HTML status code

◆ qmuniGetProfile()

void qmuniGetProfile ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

gets data about the logged in user

Parameters
[out]TEXTmodel Json of that contains profile data
Returns
INTEGER HTML status code

◆ qmuniGetProfileImage()

void qmuniGetProfileImage ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

downloads the profile image of the given profile id to the the given location. If a 0 length string is given for file name then it will name it contactImagecontactID. If a 0 length string is given for the path the home directory is chosen.

Parameters
[in]LONGINTprofile_id
[in]TEXTname name to save the file as
[in]TEXTpath Absolute or relative path for where to save the file to
[out]TEXTmodel Json that contains a report of any errors or changes that occurred when trying to download the attachment
Returns
INTEGER HTML status code

◆ qmuniGetProfileRolesList()

void qmuniGetProfileRolesList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Get Profile Roles: get list of all roles for the current application

Parameters
[out]TEXTmodel Json array of the all roles and the profiles using them for the application
Returns
INTEGER HTML status code

◆ qmuniGetProfilesForRoleList()

void qmuniGetProfilesForRoleList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

get profile for the role: gets list of all profile that share the role

Parameters
[in]LONGINTroleID - id of role that all users in the list will share
[out]TEXTmodel Json array of the all of the profiles that share the role
Returns
INTEGER HTML status code

◆ qmuniGetRoleList()

void qmuniGetRoleList ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Get Role List: get list of all roles for the given app

Parameters
[out]TEXTmodel Json that contains nothing
Returns
INTEGER HTML status code

◆ qmuniGetSMTPHost()

void qmuniGetSMTPHost ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

get SMTP Host: returns the logged in users current SMTP Host settings

Parameters
[out]TEXTmodel Json that contains all the profile default settings
Returns
INTEGER status_code HTML status code of the add profile request

◆ qmuniHideConversation()

void qmuniHideConversation ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Hides a specific conversation.

Parameters
[in]LONGINTconversation_id The id of the conversation to be hidden.
[out]TEXTmodel Json that contains the conversation id of the now hidden conversation
Returns
INTEGER HTML status code

◆ qmuniHideConversationBatch()

void qmuniHideConversationBatch ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Hide Conversations in Batch: Sets a list of conversations' hidden value.

Parameters
[in]BOOLshouldHide if the conversations should be set to hidden(true) or unhidden(false)
[in]ARRAY_LONGINTconversationIDs IDs of the conversations to hide or unhide.
[out]TEXTmodel Json that contains the hide until date
Returns
INTEGER HTML status code

◆ qmuniHideConversationUntil()

void qmuniHideConversationUntil ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Hides a conversation until the given date

Parameters
[in]LONGINTconversation_id The id of the conversation to be hidden.
[in]LONGINThide_date date the conversion will no longer be hidden
[out]TEXTmodel Json that contains the hide until date
Returns
INTEGER HTML status code

◆ qmuniHideConversationUntilBatch()

void qmuniHideConversationUntilBatch ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Hide Conversations until in Batch: Sets a list of conversations' hidden value.

Parameters
[in]Datedate The date the conversation will be unhidden.
[in]Timetime The time the conversation will be unhidden.
[in]ARRAY_LONGINTconversation_ids IDs of the conversations to hide until.
[out]TEXTmodel Json that contains the hide until date
Returns
INTEGER HTML status code

◆ qmuniLog()

void qmuniLog ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Writes the given message to the log file with the given log level.

Parameters
[in]TEXTMessage
[in]LONGINTlogLevel Log level

◆ qmuniLogin()

void qmuniLogin ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Logs into qmuni using their email and code and returns an html status code that results from the attempted login.

Parameters
[in]TEXTappToken the qmuni application token for the application to login to,
[in]TEXTemail the email address of the user attempting to login,
[in]TEXTcode the code of associated with email address for the login attempt.
[out]TEXTsession_token Qmuni session token.
Returns
INTEGER HTML status code

◆ qmuniLoginSimple()

void qmuniLoginSimple ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Recommeded function to use when using qcryptor to login to qmuni

Parameters
[in]TEXTappToken the qmuni application token for the application to login to,
[in]TEXTemail the email address of the user attempting to login,
[in]TEXTcode hash generated with salt1 and users password
[out]TEXTsession_token Qmuni session token.
Returns
INTEGER HTML status code

◆ qmuniLogout()

void qmuniLogout ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Logs the user out of qmuni and returns an html status code.

Returns
INTEGER HTML status code

◆ qmuniOk()

void qmuniOk ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Checks with qmuni to see if user is still logged in.

Returns
Integer HTML status code

◆ qmuniRequestBusiness()

void qmuniRequestBusiness ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

creates a qmuni business and returns an html status code that results. After it is approved call qmuniAddBusiness to add credentials and start using qmuni

Parameters
[in]TEXTname name of the business appling to register for qmuni
[in]TEXTfirstName first name of the person requesting a qmuni business account
[in]TEXTlastName last name of the person requesting a qmuni business account
[in]TEXTemail the email address of the person requesting a qmuni business account
[in]TEXTphone phone number of the person requesting a qmuni business account
[out]TEXTjson Response json for the request
Returns
INTEGER HTML status code

◆ qmuniSendFile()

void qmuniSendFile ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Sends file to server so it can be attached to a message.

Parameters
[in]TEXTpath absolute or relitive path of the file being sent.
[in]TEXTmime Content-Type/MIME of the file
[in]TEXTname Name of the file
[out]TEXTmodel Json that contains file name, mime type, size, path to file on server, and file id
Returns
INTEGER status_code HTML status code of the send file request

◆ qmuniSendMessage()

void qmuniSendMessage ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Sends a specific message to the users in the conversation it is a part of. [in] LONGINT message_id

Parameters
[out]TEXTJson that contains nothing
Returns
INTEGER status_code HTML status code of the send request

◆ qmuniSendMessageToContacts()

void qmuniSendMessageToContacts ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)
Parameters
[in]LONGINTmessage_id
[in]ARRAY_LONGINTarray of contact ids
[out]TEXTmodel Json that contains nothing
Returns
INTEGER HTML status code

◆ qmuniSendWelcomeEmail()

void qmuniSendWelcomeEmail ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Send Welcome Email: sends a Welcome email to each profile listed with the template associated with the role

Parameters
[in]TEXTrole the type of welcome email to send
[in]ARRAY_LONGINTprofileList list of profiles to receive the welcome email
[out]TEXTjson Response json for the request

◆ qmuniSetPort()

void qmuniSetPort ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Sets the port qmuni calls use

Parameters
[in]TEXTport The port number to be set

◆ qmuniSetWatchers()

void qmuniSetWatchers ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Set Watchers: set a group of profiles watchere status for a conversation

Parameters
[in]int64_tconversationID the id of the conversation whos participants are changing watcher status
[in]ARRAY_LONGwatcherProfiles list of profile ids of the profiles whos watcher status is changing
[in]BOOLisWatcher if the profiles for the conversation are being set as a watcher or not
[out]TEXTmodel Json of that contains the updated ??
Returns
INTEGER HTML status code

◆ qmuniUnhideConversation()

void qmuniUnhideConversation ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Unhides a specific conversation.

Parameters
[in]LONGINTconversation_id The id of the conversation to be unhidden.
[out]TEXTmodel Json that contains conversation id of the revealed converstion
Returns
INTEGER HTML status code

◆ qmuniUpdateHiddenFile()

void qmuniUpdateHiddenFile ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)
Parameters
[in]LONGINTfile_id to download
[in]BOOLshouldHide the hidden state to set the File to
[out]TEXTmodel Json that contains a report of any erros that occured when trying to download the attachment
Returns
INTEGER HTML status code

◆ qmuniUpdateProfile()

void qmuniUpdateProfile ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Updates the specified key(phone number, first name, last name) to contain the given value [in] TEXT key [in] TEXT value [out] TEXT model Json that contains all of the key value pairs associated with the profile

Returns
INTEGER HTML status code

◆ qmuniUpdateProfileImage()

void qmuniUpdateProfileImage ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

Changes logged in users profile image file found in the provided path. [in] TEXT path absolute or relitive path to the new profile image file [in] TEXT type image type (.jpg, .gif, ect) [in] TEXT name name of the file

Parameters
[out]TEXTmodel Json of that contains information about the profile image upload
Returns
INTEGER HTML status code

◆ qSetServer()

void qSetServer ( sLONG_PTR *  pResult,
PackagePtr  pParams 
)

◆ to_string()

std::string to_string ( C_TEXT &  text)