ISmsDevice ISmsDevice ISmsDevice ISmsDevice Interface

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

Note

This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see Mobile Broadband: device apps.

Syntax

Declaration

public interface ISmsDevicepublic interface ISmsDevicePublic Interface ISmsDevice

Properties summary

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.

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.

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.

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.

Methods summary

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.

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.

Events summary

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.

Properties

  • AccountPhoneNumber
    AccountPhoneNumber
    AccountPhoneNumber
    AccountPhoneNumber

    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.

    public string AccountPhoneNumber { get; }public string AccountPhoneNumber { get; }Public ReadOnly Property AccountPhoneNumber As string

    Property Value

    • string
      string
      string
      string

      A string representation of the account phone number.

  • CellularClass
    CellularClass
    CellularClass
    CellularClass

    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.

    public CellularClass CellularClass { get; }public CellularClass CellularClass { get; }Public ReadOnly Property CellularClass As CellularClass

    Property Value

  • DeviceStatus
    DeviceStatus
    DeviceStatus
    DeviceStatus

    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.

    public SmsDeviceStatus DeviceStatus { get; }public SmsDeviceStatus DeviceStatus { get; }Public ReadOnly Property DeviceStatus As SmsDeviceStatus

    Property Value

  • MessageStore
    MessageStore
    MessageStore
    MessageStore

    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.

    public SmsDeviceMessageStore MessageStore { get; }public SmsDeviceMessageStore MessageStore { get; }Public ReadOnly Property MessageStore As SmsDeviceMessageStore

    Property Value

Methods

  • CalculateLength(Windows.Devices.Sms.SmsTextMessage)
    CalculateLength(Windows.Devices.Sms.SmsTextMessage)
    CalculateLength(Windows.Devices.Sms.SmsTextMessage)
    CalculateLength(Windows.Devices.Sms.SmsTextMessage)

    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.

    public SmsEncodedLength CalculateLength(Windows.Devices.Sms.SmsTextMessage message)public SmsEncodedLength CalculateLength(Windows.Devices.Sms.SmsTextMessage message)Public Function CalculateLength(message As Windows.Devices.Sms.SmsTextMessage) As SmsEncodedLength

    Parameters

    Returns

  • SendMessageAsync(Windows.Devices.Sms.ISmsMessage)
    SendMessageAsync(Windows.Devices.Sms.ISmsMessage)
    SendMessageAsync(Windows.Devices.Sms.ISmsMessage)
    SendMessageAsync(Windows.Devices.Sms.ISmsMessage)

    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.

    public SendSmsMessageOperation SendMessageAsync(Windows.Devices.Sms.ISmsMessage message)public SendSmsMessageOperation SendMessageAsync(Windows.Devices.Sms.ISmsMessage message)Public Function SendMessageAsync(message As Windows.Devices.Sms.ISmsMessage) As SendSmsMessageOperation

    Parameters

    Returns

Events

  • SmsDeviceStatusChanged
    SmsDeviceStatusChanged
    SmsDeviceStatusChanged
    SmsDeviceStatusChanged

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

    public abstract event SmsDeviceStatusChangedEventHandler SmsDeviceStatusChangedpublic abstract event SmsDeviceStatusChangedEventHandler SmsDeviceStatusChangedPublic MustInherit Event SmsDeviceStatusChanged
  • SmsMessageReceived
    SmsMessageReceived
    SmsMessageReceived
    SmsMessageReceived

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

    public abstract event SmsMessageReceivedEventHandler SmsMessageReceivedpublic abstract event SmsMessageReceivedEventHandler SmsMessageReceivedPublic MustInherit Event SmsMessageReceived

Device family

Windows Desktop Extension SDK (introduced v10.0.10240.0)

API contract

Windows.Devices.Sms.LegacySmsApiContract (introduced v1)

Capabilities

sms
cellularMessaging

Attributes

Windows.Foundation.Metadata.GuidAttribute
Windows.Foundation.Metadata.DeprecatedAttribute
Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.Devices.Sms.dll