Windows.Devices.Sms.LegacySmsApiContract

Enables start, track, and end an asynchronous message delete operation for a single message.

DeleteSmsMessageOperation may be altered or unavailable for releases after Windows 10.

Specifies whether the asynchronous SMS message delete operation has completed or not.

A handler for the completed event of an asynchronous action.

Specifies the error code for the asynchronous SMS message delete operation.

The result value of the asynchronous operation.

Specifies the ID of the asynchronous SMS message delete operation.

An integer that uniquely represents the asynchronous SMS message delete operation.

Specifies the status of the asynchronous SMS message delete operation.

An enumerated value representing the status of the asynchronous SMS message delete operation.

Cancels the asynchronous SMS message delete operation.

Closes the asynchronous SMS message delete operation.

Retrieves the result of the asynchronous SMS message delete operation.

Enables start, track, and end asynchronous SMS message delete operations for multiple messages.

DeleteSmsMessagesOperation may be altered or unavailable for releases after Windows 10.

Specifies whether the asynchronous SMS message delete operations have completed or not.

A handler for the completed event of an asynchronous SMS message delete operation.

Specifies the error code for the asynchronous SMS message delete operations.

The result value of the asynchronous SMS message delete operations.

Specifies the ID of the asynchronous SMS message delete operations.

An integer that uniquely represents the asynchronous SMS message delete operations.

Specifies the status of the asynchronous SMS message delete operations.

An enumerated value representing the status of the asynchronous SMS message delete operations.

Cancels the asynchronous SMS message delete operations.

Closes the asynchronous SMS message delete operations.

Retrieves the result of the asynchronous message operations.

Retrieves an SmsDevice object asynchronously.

GetSmsDeviceOperation may be altered or unavailable for releases after Windows 10.

Specifies whether the asynchronous SmsDevice object retrieval operation has completed or not.

A handler for the completed event of an asynchronous action.

Specifies the error code for the asynchronous SmsDevice object retrieval operation

The result value of the asynchronous operation.

Specifies the ID of the asynchronous SmsDevice object retrieval operation.

An integer that uniquely represents the asynchronous SmsDevice object retrieval operation.

Specifies the status of the asynchronous SmsDevice object retrieval operation.

An enumerated value representing the status of an asynchronous SmsDevice object retrieval operation.

Cancels the asynchronous SmsDevice object retrieval.

Closes the asynchronous SmsDevice object retrieval operation.

Gets the results of the asynchronous SmsDevice object retrieval operation.

A reference to an SmsDevice object.

Supports the retrieval of a message from the SMS message store.

GetSmsMessageOperation may be altered or unavailable for releases after Windows 10.

A handler for the completed event of an asynchronous SMS message retrieval operation.

Specifies the error code for the asynchronous SMS message retrieval operation.

The result value of the asynchronous SMS message retrieval operation.

Specifies the ID of the asynchronous SMS message retrieval operation.

An integer uniquely representing the asynchronous SMS message retrieval operation.

Specifies the status of the asynchronous SMS message retrieval operation.

An enumerated value representing the status of an asynchronous SMS message retrieval operation.

Cancels the asynchronous SMS message retrieval operation.

Closes the asynchronous SMS message retrieval operation.

Retrieves the result of the asynchronous SMS message retrieval operation.

An interface that accesses the retrieved message.

Supports the retrieval of messages.

GetSmsMessagesOperation may be altered or unavailable for releases after Windows 10.

Specifies whether the asynchronous message retrieval operation has completed or not.

Specifies whether the asynchronous message operation has completed or not.

Specifies the error code for the asynchronous message operation.

The result value of the asynchronous operation.

Indicates the ID of the asynchronous message operation.

An integer uniquely representing the asynchronous operation.

Specifies the progress status of the asynchronous message operation.

A handler for progress update events of an asynchronous operation.

Specifies the status of the asynchronous message operations.

An enumerated value representing the status of an asynchronous operation.

Cancels the asynchronous operations.

Closes the asynchronous operations.

Retrieves the result of the asynchronous message retrieval operation.

A reference to the SMS messages retrieved.

This interface provides access to the raw binary format of an SMS message. The message is stored in the industry standard protocol description unit (PDU) format (see the SMS specification GSM 03.40).

SmsBinaryMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsAppMessage.

Retrieves the detected protocol description unit (PDU) format of this message.

An enumerated value describing the SMS data format.

Returns the raw buffer of the message in binary protocol description unit (PDU) format as a byte array.

SmsBinaryMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsAppMessage. A byte array representing message data. If there is no message data, the returned array is empty.

Specifies the raw binary payload of the SMS message. It should be formatted according to the protocol description unit (PDU) standard.

SmsBinaryMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsAppMessage. A byte array representing message data, formatted according to the protocol description unit (PDU) standard.

This interface controls a mobile broadband SMS device. It is the primary entry point to SMS services on the device.

SmsDevice may be altered or unavailable for releases after Windows 10. Instead, use SmsDevice2.

Returns the phone number associated with the SMS device. The phone number can be used to associate incoming messages with the account and possibly an external storage mechanism such as an account inbox.

A string representation of the account phone number.

Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect.

An enumerated value indicating the device's cellular class.

Returns the SMS device's status, which indicates whether the device is ready, or not. It also indcates what type of problem exists if the device is not ready.

An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations.

Accesses the on-device message store. The store holds messages until a client can retrieve them. On some devices, for example, the store may correspond to the SIM storage for SMS messages.

A reference to an SmsMessageStore object.

Sets an event handler to be called when the status of the SMS device changes.

Sets an event handler to be called when the device receives a new text message.

Estimates the transmitted message length of the specified text message. The estimate can be useful to clients who want to give an indication of how many messages will be sent on the network to carry the text of the full message.

SmsDevice may be altered or unavailable for releases after Windows 10. Instead, use SmsDevice2. A reference to the SMS text message to measure. A reference to an SmsEncodedLength structure that is populated with the length information.

Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The asynchronous operation object is returned immediately.

SmsDevice may be altered or unavailable for releases after Windows 10. Instead, use SmsDevice2. A reference to an SmsMessage object. The message can be in text or binary format. A reference to an SendSmsMessageOperation object that supports asynchronous message sending.

This interface is implemented by all types of SMS messages that are supported.

Retrieves an ID for the message, which can later be specified in calling message store methods in order to get or delete the message.

An integer ID for the message.

Returns the message class, as determined by the operator's message network. The two most common classes are None (normal message) or Class0 (special operator message, such as a roaming warning that must be shown immediately to the user). A typical client for end-user messages ignores Class0 messages.

A value from the SmsMessageClass enumeration.

This interface manipulates a decoded SMS text message. It provides direct access to the plain text body of the message, as well as key header properties, such as time stamp.

SmsTextMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsTextMessage2.

Specifies the plain text body of the message.

A string representing the body of the text message. If there were decoding problems, some characters in the original message can be represented by a wildcard character, typically a question mark: '?'.

Specifies the encoding type that has been set to use when sending this message.

A value from the SmsEncoding enumeration.

Specifies the phone number of the sender of the message.

A string representation of the phone number of the sender of this message. It should be in the format preferred by the device and the network it is registered on.

Retrieves the total number of parts in the original message if the message is part of a multi-part message.

An unsigned integer. If the message is standalone, the value is 1.

Retrieves the part number of a multi-part message if this message is part of a multi-part message. It can be used to reconstruct the original message by joining the parts together, in conjunction with the PartReferenceId and PartCount properties.

An unsigned integer. It is one-based. It will not exceed PartCount + 1.

Indicates a reference value that can be used if the message is part of a multi-part message. If this message belongs to a multi-part message, the PartNumber value can be used to reconstruct the full original message, and each part of that message will have the same value for PartReferenceId.

An unsigned integer determined by the sending network; it cannot be manipulated through this interface. If the network has its own policy on the lifetime of a multi-part message, this reference number might not be valid indefinitely.

Retrieves the timestamp of the message. It is determined locally for a constructed message instance or from the service center timestamp of a received message.

A value of the DateTime type.

Specifies the recipient phone number of this message.

A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on.

Reads a message in the specified format and places the results in a new instance of a binary message.

SmsTextMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsTextMessage2. A value from the SmsDataFormat enumeration. The new binary message that holds the result of this method call.

Enables the sending of a message.

SendSmsMessageOperation may be altered or unavailable for releases after Windows 10.

A handler for the completed event of an asynchronous action.

Specifies the error code for the asynchronous message operation.

The result value of the asynchronous operation.

Indicates the ID of the asynchronous message operation.

An integer uniquely representing the asynchronous operation.

Specifies the status of the asynchronous message operation.

An enumerated value representing the status of an asynchronous operation.

Cancels the asynchronous operation.

Closes the asynchronous operation.

Retrieves the result of the asynchronous operation.

Represents an SMS message in raw PDU format. The data format differs depending on whether the message format (indicated by the value of the Format property) is GSM or CDMA.

SmsBinaryMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsAppMessage.

Creates an instance of the SmsBinaryMessage class.

Retrieves the detected protocol description unit (PDU) format of this message.

An enumerated value describing the SMS data format.

Indicates the ID of the asynchronous message operation.

An integer uniquely representing the asynchronous operation.

A value from the SmsMessageClass enumeration.

Returns the raw buffer of the message in binary protocol description unit (PDU) format as a byte array.

Specifies the raw binary payload of the SMS message. It should be formatted according to the protocol description unit (PDU) standard.

Supports the operation of a mobile broadband SMS device.

SmsDevice may be altered or unavailable for releases after Windows 10. Instead, use SmsDevice2.

A string representation of the account phone number.

Returns the cellular class of the SMS device. The class can be used to determine which encodings are appropriate or which device limitations are in effect.

An enumerated value indicating the device's cellular class.

Returns the SMS device's status, which indicates whether the device is ready, or not. It also indicates what type of problem exists if the device is not ready.

An enumerated value that indicates the readiness of an SMS device to engage in cellular network traffic operations.

Accesses the on-device message store. The store holds messages until a client can retrieve them. On some devices, for example, the store may correspond to the SIM storage for SMS messages.

A reference to an SmsDeviceMessageStore object.

Sets an event handler to be called when the status of the SMS device changes.

Sets an event handler to be called when the device receives a new text message.

Creates an instance of SmsDevice for the device that received the SMS message.

ISmsDeviceStatics may be altered or unavailable for releases after Windows 10. A string representation of the DeviceInformation ID of the SMS device that received the SMS message. The SMS device operation object.

Creates an instance of SmsDevice for the specified Mobile Broadband network account ID.

ISmsDeviceStatics2 may be altered or unavailable for releases after Windows 10. The Mobile Broadband network account ID to use to select the corresponding mobile broadband device to use for the SMS device When this method completes, it returns the SmsDevice for the specified Mobile Broadband network account ID.

Creates an instance of an SmsDevice object associated with the default SMS device. Because the device might be busy, the operation executes asynchronously. The asynchronous operation object returns immediately.

ISmsDeviceStatics may be altered or unavailable for releases after Windows 10. A reference to an IAsyncOperation(SmsDevice) object that supports asynchronous SmsDevice object retrieval.

Retrieves the class selection string that can be used to enumerate SMS devices.

ISmsDeviceStatics may be altered or unavailable for releases after Windows 10. A reference to an Advanced Query Syntax (AQS) string that identifies an SMS device.

Asynchronously sends a message using the SMS device. The method is asynchronous because the send operation might not occur instantaneously. The message operation object is returned immediately.

SmsDevice may be altered or unavailable for releases after Windows 10. Instead, use SmsDevice2. A reference to an ISmsMessage object. The message can be in text or binary format. The message operation object.

Provides access to the messages stored on an SMS Device and information about the message store.

SmsDeviceMessageStore may be altered or unavailable for releases after Windows 10.

Indicates the maximum number of messages that can be stored in the device store. The client can use this value to determine how to maintain enough space in the device store to receive new messages from the network.

An integer value representing the maximum number of messages for the device store.

Deletes the message with the specified ID. Because the device might be busy, the operation executes asynchronously. The asynchronous operation object returns immediately.

SmsDeviceMessageStore may be altered or unavailable for releases after Windows 10. Integer ID of the message to delete, which was previously read from an SmsTextMessage object obtained from the device message store. A new message operation object that is used to start and track the asynchronous operation.

Deletes the messages to which the filter applies. The filter can be used to delete all messages, or only messages that are read, unread, sent, or in a draft state. Because the operation might not be instantaneous, it executes asynchronously. The asynchronous operation object returns immediately.

SmsDeviceMessageStore may be altered or unavailable for releases after Windows 10. A search filter that specifies which messages to delete. A new message operation object that is used to start and track the asynchronous operation.

Retrieves the message with the specified ID. The device might be busy, so the method executes asynchronously. The asynchronous operation object returns immediately.

SmsDeviceMessageStore may be altered or unavailable for releases after Windows 10. ID of the message to retrieve. Returns a new message operation object that is used to start and track the asynchronous operation.

Retrieves a list of messages that match the conditions specified in a filter. The messages can be filtered as read, unread, sent, or in the draft state.

This handler is called when the status on the SMS device changes. Callers should implement this when they want to be notified when a significant state change occurs on the device. For example, the caller might want to know when the device is ready to send and receive messages.

SmsDeviceStatusChangedEventHandler may be altered or unavailable for releases after Windows 10. A reference to the device object that sent the event.

This enumerated type specifies which messages in the device message store an operation is performed on.

SmsMessageFilter may be altered or unavailable for releases after Windows 10.

All messages in the device message store.

All unsent and saved messages.

All read received messages.

All sent and saved messages.

All unread received messages.

Provides data for ISmsBinaryMessage event handlers.

SmsMessageReceivedEventArgs may be altered or unavailable for releases after Windows 10.

Retrieves an object that holds the binary representation of the message. This is of interest only to clients who want to pass binary messages on directly or do their own interpretation of the binary message contents.

A reference to an SmsBinaryMessage object.

Retrieves an object that holds the text representation of the message. If the message is not successfully decoded, an error is returned.

A new SmsTextMessage object.

This event handler is called when a new binary message is received. Callers should implement this when they want to handle new binary messages from a given SMS device.

SmsMessageReceivedEventHandler may be altered or unavailable for releases after Windows 10. A reference to the SMS device object that sent the message. An object that holds the binary and text representations of the message.

Presents the details of SMS message events to the background work item that handles messages while your app is suspended.

SmsReceivedEventDetails may be altered or unavailable for releases after Windows 10. Instead, use SmsMessageReceivedTriggerDetails.

Gets the binary message object for the SMS message received by the background task.

The binary message object for the SMS message received by the background task.

Returns the DeviceInformation ID of the network interface that received the SMS message. This ID can be passed to SmsDevice.FromIdAsync to activate the device and retrieve additional message details.

A string containing the DeviceInformation ID of the SMS network interface (device). This value is typically used to retrieve details such as the sender and the body of the message. For example, you might use the ID to display a popup telling the user that a new message from a particular person has arrived. The combination of DeviceId and MessageIndex is sufficient to retrieve the new message from the SMS device.

Gets the message class for the SMS message received by the background task.

The message class for the SMS message received by the background task.

Returns the index of the new message that raised the event. You can pass this to SmsDevice.GetMessageAsync to retrieve the new message itself.

An integer index of the new message.

Manages a decoded SMS text message, providing direct access to the plain text body of the message, as well as key header properties, such as time stamp.

SmsTextMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsTextMessage2.

Creates an instance of the SmsTextMessage class.

Specifies the plain text body of the message.

Specifies the encoding type that has been set to use when sending this message.

A value from the SmsEncoding enumeration.

Specifies the phone number of the sender of the message.

A string representation of the phone number of the sender of this message. It should be in the format preferred by the device and the network it is registered on.

Indicates the ID of the SMS text message.

An integer ID for the message.

Specifies the message class of a message. This message class typically originates on the network, not the mobile device.

A value from the SmsMessageClass enumeration.

Indicates the total number of parts in the original message if the message is part of a multi-part message.

An unsigned integer. If the message is standalone, the value is 1.

Indicates the part number of a multi-part message if this message is part of a multi-part message. It can be used to reconstruct the original message by joining the parts together, in conjunction with the PartReferenceId and PartCount properties.

An unsigned integer. It is one-based. It will not exceed PartCount + 1.

Indicates the timestamp of the message. It is determined locally for a constructed message instance or from the service center timestamp of a received message.

A value of the DateTime type.

Indicates the recipient phone number of this message.

A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on.

Decodes a binary message and places the results in a new instance of a text message. This method represents the binary message as a reference to a buffer of bytes and a selection of how the buffer is encoded. Therefore, it can be used when the message did not originate directly from the device or as an instance of an SmsBinaryMessage class.

ISmsTextMessageStatics may be altered or unavailable for releases after Windows 10. An SmsDataFormat enumerated value that identifies the format of a particular protocol description unit (PDU) buffer. An array of bytes containing the binary data to decode. A new SmsTextMessage object if the decoding was successful.

Reads a binary message and decodes it. The results are placed in a new instance of a text message.

ISmsTextMessageStatics may be altered or unavailable for releases after Windows 10. An instance of a binary message to decode. A new SmsTextMessage object.

Reads a message in the specified format and places the results in a new instance of a binary message.