C# Class Rock.Communication.Medium.Sms

Inheritance: MediumComponent

Mostrar archivo Open project: NewSpring/Rock Class Usage Examples

Public Methods

Method	Description
GetControl ( bool useSimpleMode ) : MediumControl	Gets the control.
GetHtmlPreview ( System.ComponentModel.Model communication, Person person ) : string	Gets the HTML preview.
GetMessageDetails ( System.ComponentModel.Model communication ) : string	Gets the read-only message details.
ProcessResponse ( string toPhone, string fromPhone, string message, string &errorMessage ) : void	Process inbound messages that are sent to a SMS number.
Send ( System.ComponentModel.Model communication ) : void	Sends the specified communication.

Private Methods

Method	Description
AppendMediumData ( System.ComponentModel.Model communication, StringBuilder sb, string key ) : void
AppendMediumData ( StringBuilder sb, string key, string value ) : void
CreateCommunication ( int fromPersonAliasId, string fromPersonName, int toPersonAliasId, string message, string transportPhone, string responseCode, Rock rockContext ) : void	Creates a new communication.
GenerateResponseCode ( Rock rockContext ) : string	Creates a recipient token to help track conversations.

Method Details

GetControl() public method

Gets the control.

public GetControl ( bool useSimpleMode ) : MediumControl
useSimpleMode	bool	if set to true [use simple mode].
return	Rock.Web.UI.Controls.Communication.MediumControl

GetHtmlPreview() public method

Gets the HTML preview.

public GetHtmlPreview ( System.ComponentModel.Model communication, Person person ) : string
communication	System.ComponentModel.Model	The communication.
person	Person	The person.
return	string

GetMessageDetails() public method

Gets the read-only message details.

public GetMessageDetails ( System.ComponentModel.Model communication ) : string
communication	System.ComponentModel.Model	The communication.
return	string

ProcessResponse() public method

Process inbound messages that are sent to a SMS number.

public ProcessResponse ( string toPhone, string fromPhone, string message, string &errorMessage ) : void
toPhone	string	The phone number a message is sent to.
fromPhone	string	The phone number a message is sent from.
message	string	The message that was sent.
errorMessage	string	The error message.
return	void

Send() public method

Sends the specified communication.

public Send ( System.ComponentModel.Model communication ) : void
communication	System.ComponentModel.Model	The communication.
return	void