CCSoftSendSMS::CCSoftSendSMS()

CCSoftSendSMS::CCSoftSendSMS(
const string& Username,
const string& PIN)

CCSoftSendSMS::CCSoftSendSMS(
const string& Username,
const string& PIN,
const string& ReplyTo)

Constructors for the class. You can initialise the parameters which are usually static for the lifetime of the object at construction if you wish. Failure to set these, or to set them incorrectly is usually the reason for an invalid login response when calling the sendMessage… methods.

The destructor for the class.

FILE* CCSoftSendSMS::getLogFile()

During the sending of a message, the class will write useful debugging information to an open FILE pointer, if you supply one. To turn off logging once you have enabled, call setLogFile((FILE *)NULL). You should always turn this off before closing the file. You can use stderr as the FILE pointer if you if you wish.

void CCSoftSendSMS::setUsername(const string& Username)

void CCSoftSendSMS::getUsername(string& Username) const

Before sending a message, you must ensure that you have set both the Username and PIN. Use these methods to set and inspect your Username.

void CCSoftSendSMS::setPIN(const string& PIN)

void CCSoftSendSMS::getPIN(string& PIN) const

Before sending a message, you must ensure that you have set both the Username and PIN. Use these methods to set and inspect your PIN.

void CCSoftSendSMS::setReplyTo(const string& ReplyTo

void CCSoftSendSMS::getReplyTo(string& ReplyTo) const

If you have purchased a Dynamic TP-OA (Originator Address) from Connection Software, you can change the originating identifier of the messages you send to this tag. If you do not own any, or only have one, then this is set by default, so there is no need to call this method. But if you have more than one tag, then you can set, or inspect it, using these methods.

void CCSoftSendSMS::setSendTime(const time_t SendTimeAbsolute)

There are two mutually exclusive ways to set the time of delivery for messages you send - using an absolute date and time or an offset in minutes. Using this method you can set a UTC date and time at which to deliver a message. The current maximum limit is three days into the future. If you set a date or time that is in the past, the message will be delivered immediately.

void CCSoftSendSMS::setSendTime(
const unsigned short SendTimeDelay)

There are two mutually exclusive ways to set the time of delivery for messages you send - using an absolute date and time or an offset in minutes. Using this method you can set a delay of SendTimeDelay minutes before delivery of the message. The maximum limit is 4320 minutes, or three days.

void setProxy(
const string& ProxyHostName,
const unsigned CSoftReportCode ProxyPortNumber,
const string& ProxyUsername,
const string& ProxyPassword,
const enum CS_PROXY_TYPE ProxyType = CS_PROXY_OFF)

void setProxyType(const enum CS_PROXY_TYPE ProxyType);

CSoftSendSMS supports HTTP and WinInet proxying if you need it. To enable proxying simply make a call to this method with the right settings for your system. When you make a call which makes an internet connection, it will then use the appropriate proxy as defined.

void setHTTP(
const enum CS_HTTP_VERSION HTTPVersion = CS_HTTP_1_0,
const enum CS_HTTP_MODE HTTPMode = CS_HTTP_INSECURE);

void setHTTPVersion(
const enum CS_HTTP_VERSION HTTPVersion);

void setHTTPMode(
const enum CS_HTTP_MODE HTTPMode);

HTTP versions 1.0 and 1.1 are supported as is HTTPS. Set the mode and version you want with these methods. Important: you will need to ensure the l SSL libraries are installed for HTTPS. These are from the OpenSSL project and should have been included with this library. They are called libeay32.dll and ssleay.dll.

CSoftReportCode CCSoftSendSMS::submitMessageTextMessage(
const string& SendTo,
const string& TextMessage)

Submits a plain gsm TextMessage for delivery to the recipient(s). SendTo may be single number, or a list of numbers separated by commas.

CSoftReportCode CCSoftSendSMS::submitMessageFlashMessage(
const string& SendTo,
const string& FlashMessage)

A flash message is the same as a standard text message (see above), except that when it is received on a phone which supports flash messages, they are displayed on the screen immediately.

CSoftReportCode CCSoftSendSMS::submitMessageRingtone(
const string& SendTo,
const string& PhoneMake,
const int LibraryNumber)

There are two ways to send ringtones. You can identify the ringtone you want from the library, using its library number (this method), or you can submit a ringtone as a raw RTTTL string (see below). The ringtone must be in the Connection Software library, otherwise you will receive an error response.

CSoftReportCode CCSoftSendSMS::submitMessageRingtone(
const string& SendTo,
const string& PhoneMake,
const string& Data)

There are two ways to send ringtones. You can identify the ringtone you want from the library, using its library number (see above), or you can submit a ringtone as a raw RTTTL string. When submitting an RTTTL string, the SendTo and PhoneMake are the same as for a library number, but the Data must be a hex encoded RTTTL string. This document does not cover the RTTTL string format or hex encoding the string.

CSoftReportCode CCSoftSendSMS::submitMessageOperatorLogo(
const string& SendTo,
const string& PhoneMake,
const int MCC,
const int MNC,
const int LibraryNumber)

Send an operator logo to the recipient, or recipients, listed in SendTo. You must specify the PhoneMake, country code (MCC), and network code (MNC), as well as the library number of the logo.

CSoftReportCode CCSoftSendSMS::submitMessageOperatorLogo(
const string& SendTo,
const string& PhoneMake,
const int MCC,
const int MNC,
const string& Data)

Send an operator logo to the recipient, or recipients, listed in SendTo. You must specify the PhoneMake, country code (MCC), and network code (MNC), as well as the hex encoded OTA bitmap of the logo (DATA).

CSoftReportCode CCSoftSendSMS::submitMessageOperatorLogo(
const string& SendTo,
const string& PhoneMake,
const int MCC,
const int MNC,
const void* Data,
const time_t DataLength)

Send an operator logo to the recipient, or recipients, listed in SendTo. You must specify the PhoneMake, country code (MCC), and network code (MNC), as well as the raw OTA bitmap of the logo (Data) and it’s length (DataLength).

CSoftReportCode CCSoftSendSMS::submitMessagePictureMessage(
const string& SendTo,
const string& PhoneMake,
const int LibraryNumber,
const string& TextMessage)

Send a picture message, with an optional text message, to the recipient, or recipients, listed in SendTo. You must supply a PhoneMake and a valid library number. If you wish to include a message, include it here, otherwise supply a blank string.

CSoftReportCode CCSoftSendSMS::submitMessagePictureMessage(
const string& SendTo,
const string& PhoneMake,
const string& Data,
const string& TextMessage)

Send a picture message, with an optional text message, to the recipient, or recipients, listed in SendTo. You must supply a PhoneMake and a hex encoded OTA bitmap. If you wish to include a message, include it here, otherwise supply a blank string.

CSoftReportCode CCSoftSendSMS::submitMessagePictureMessage(
const string& SendTo,
const string& PhoneMake,
const void* Data,
const size_t DataLength,
const string& TextMessage)

Send a picture message, with an optional text message, to the recipient, or recipients, listed in SendTo. You must supply a PhoneMake and a raw OTA bitmap binary. If you wish to include a message, include it here, otherwise supply a blank string. The DataLength must be correct for the raw Data.

CSoftReportCode CCSoftSendSMS::submitMessageGroupGraphic(
const string& SendTo,
const string& PhoneMake,
const int LibraryNumber);

Send a group graphic to the recipient, or recipients, listed in SendTo. You must supply a PhoneMake and a valid library number (see www.csoft.co.uk for details of available images).

CSoftReportCode CCSoftSendSMS::submitMessageGroupGraphic(
const string& SendTo,
const string& PhoneMake,
const string& Data)

Send a group graphic to the recipient, or recipients, listed in SendTo. You must supply a PhoneMake and a hex encoded OTA bitmap (Data).

CSoftReportCode CCSoftSendSMS::submitMessageGroupGraphic(
const string& SendTo,
const string& PhoneMake,
const void* Data,
const size_t DataLength)

Send a group graphic to the recipient, or recipients, listed in SendTo. You must supply a PhoneMake and raw OTA bitmap binary (Data). The DataLength must be correct.

void CCSoftSendSMS::getLastSubmitMessageResult(
string& MessageIdentifier,
CSoftReportCode& Report,
string& Text)

Reports the return values from the last submitMessage… call. If it was successful, the MessageIdentifier will have the unique id assigned to the message by the server, the Report will have a success code (usually -2). The Text can be ignored. If the Report is a failure code, then the MessageIdentifier should be ignored (it will be –1) but the Text may contain useful information about the error.

CSoftReportCode CCSoftSendSMS::AvailableMessages(
string& Messages)

Queries the server for the approximate number of messages left on your account.

CSoftReportCode CCSoftSendSMS::AvailableCredit(
string& Credit, string& Currency)

Queries the current credit left on your account. The amount of credit is returned aCSoftReportCode with the currency it was calculated in.

void CCSoftSendSMS::setMessageIdentifier(
const string& MessageIdentifier)

void CCSoftSendSMS::setMessageIdentifier(
const char* MessageIdentifier)

void CCSoftSendSMS::setReport(
const CSoftReportCode Report)

void CCSoftSendSMS::setText(
const string& Text)

void CCSoftSendSMS::setText(
const char* Text)

These are helper methods for the class, and are not intended for regular use, but have been declared public in case you wish to derive your own class and functionality from CCSoftSendSMS.