}}
    Show / Hide Table of Contents

    Class MessageComposer

    Inheritance
    object
    Composer
    MessageComposer
    SMSComposer
    VoiceComposer
    Implements
    IComposer
    IMessageComposer
    ISchedule
    Inherited Members
    Composer._userData
    Composer._destIdsMap
    Composer._destNumberMap
    Composer._destinations
    Composer._category
    Composer._customDataLabel
    Composer.__DEST_INFO_LABEL__
    Composer.__DEST_COUNTRYCODE_LABEL__
    Composer.setUserData(UserData)
    Composer.getCategory()
    Composer.getDestinationsCount()
    Composer.getDestinationWriteMode(string)
    Composer.getDestinationWriteModeById(string)
    Composer.getMappedDestinations(string)
    Composer.getMappedDestinationById(string)
    Composer.getComposerDestinationById(string)
    Composer.getComposerDestinations(string)
    Composer.getDefaultTimeZone()
    Composer.formattedDestinationExists(string)
    Composer.destinationExists(string)
    Composer.formatPhoneNumber(string, bool)
    Composer.formatPhoneNumber(string)
    Composer.clearDestinations()
    Composer.removeDestinationsList(string, List<ComposerDestination>)
    Composer.removeDestination(string)
    Composer.updateDestination(ComposerDestination, string)
    Composer.updateDestination(string, string)
    Composer.getPhoneNumberFromMessageId(string)
    Composer.addDestinationsFromTextStream(string)
    Composer.addDestinationsFromCollection(string[])
    Composer.addDestinationsFromCollection(string[], bool)
    Composer.addDestinationsFromCollection(List<string>)
    Composer.addDestinationsFromCollection(List<string>, bool)
    Composer.addDestinationsFromCollectionEx(string[], bool)
    Composer.addDestinationEx(string, bool)
    Composer.addDestinationWithId(string, string, bool)
    Composer.addDestination(string)
    Composer.addDestination(string, string)
    Composer.addDestination(string, bool)
    Composer.addDestination(string, bool, string)
    Composer.addDestination(string, string, string, object)
    Composer.addDestinationsList(List<ComposerDestination>, string)
    Composer.addDestination(ComposerDestination, string)
    Composer.addDestination(ComposerDestination)
    Composer.createComposerDestination(string, string, DestinationMode, object)
    Composer.createComposerDestination(string, string, DestinationMode, object, bool)
    Composer.removeDestination(ComposerDestination)
    Composer.validateCustomMessageId(string, bool)
    Composer.getDefaultDestinationCountry()
    Composer.getDestinationCountry(string)
    Composer.getDestinationCountryCode(string)
    Composer.getDestinations()
    Composer.destinationIdExists(string)
    Composer.setDefaultNumberPrefix(string)
    Composer.getDefaultNumberPrefix()
    Composer.getRouteCountries()
    Composer.getRouteCountriesEx()
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.Finalize()
    object.MemberwiseClone()
    Namespace: Zenoph.Notify.Compose
    Assembly: Zenoph.Notify.dll
    Syntax
    [ComVisible(true)]
    [Guid("7D019B3A-1CFA-4CAD-A8D4-BF6B59433626")]
    public abstract class MessageComposer : Composer, IComposer, IMessageComposer, ISchedule

    Constructors

    MessageComposer()

    Declaration
    public MessageComposer()

    MessageComposer(AuthProfile)

    Declaration
    public MessageComposer(AuthProfile ap)
    Parameters
    Type Name Description
    AuthProfile ap

    Fields

    _batchId

    Declaration
    protected string _batchId
    Field Value
    Type Description
    string

    _delivCallbackAccept

    Declaration
    protected ContentType _delivCallbackAccept
    Field Value
    Type Description
    ContentType

    _delivCallbackURL

    Declaration
    protected string _delivCallbackURL
    Field Value
    Type Description
    string

    _isScheduled

    Declaration
    protected bool _isScheduled
    Field Value
    Type Description
    bool

    _message

    Declaration
    protected string _message
    Field Value
    Type Description
    string

    _scheduler

    Declaration
    protected Schedule _scheduler
    Field Value
    Type Description
    Schedule

    _sender

    Declaration
    protected string _sender
    Field Value
    Type Description
    string

    Methods

    createDestinationMap(string, string, DestinationMode, object, bool)

    Declaration
    protected override Dictionary<string, object> createDestinationMap(string phoneNumber, string messageId, DestinationMode mode, object data, bool scheduled)
    Parameters
    Type Name Description
    string phoneNumber
    string messageId
    DestinationMode mode
    object data
    bool scheduled
    Returns
    Type Description
    Dictionary<string, object>
    Overrides
    Composer.createDestinationMap(string, string, DestinationMode, object, bool)

    removeDestinationById(string)

    Declaration
    public override bool removeDestinationById(string messageId)
    Parameters
    Type Name Description
    string messageId
    Returns
    Type Description
    bool
    Overrides
    Composer.removeDestinationById(string)

    updateDestinationById(string, string)

    Declaration
    public override bool updateDestinationById(string messageId, string phoneNumber)
    Parameters
    Type Name Description
    string messageId
    string phoneNumber
    Returns
    Type Description
    bool
    Overrides
    Composer.updateDestinationById(string, string)

    validateDestinationUpdate(string, string)

    Declaration
    protected override Dictionary<string, object> validateDestinationUpdate(string prePhoneNumber, string newPhoneNumber)
    Parameters
    Type Name Description
    string prePhoneNumber
    string newPhoneNumber
    Returns
    Type Description
    Dictionary<string, object>
    Overrides
    Composer.validateDestinationUpdate(string, string)

    Explicit Interface Implementations

    getBatchId()

    Declaration
    [ComVisible(true)]
    string getBatchId()
    Returns
    Type Description
    string

    getDeliveryCallback()

    Declaration
    [ComVisible(true)]
    object[] getDeliveryCallback()
    Returns
    Type Description
    object[]

    getMessage()

    Declaration
    [ComVisible(true)]
    string getMessage()
    Returns
    Type Description
    string

    getMessageId(string)

    Declaration
    [ComVisible(true)]
    virtual string getMessageId(string phoneNumber)
    Parameters
    Type Name Description
    string phoneNumber
    Returns
    Type Description
    string

    getScheduleInfo()

    Declaration
    [ComVisible(false)]
    object[] getScheduleInfo()
    Returns
    Type Description
    object[]

    getSender()

    Declaration
    [ComVisible(true)]
    string getSender()
    Returns
    Type Description
    string

    isScheduled()

    Declaration
    [ComVisible(true)]
    bool isScheduled()
    Returns
    Type Description
    bool

    messageIdExists(string)

    Declaration
    [ComVisible(true)]
    bool messageIdExists(string messageId)
    Parameters
    Type Name Description
    string messageId
    Returns
    Type Description
    bool

    notifyDeliveries()

    Declaration
    [ComVisible(true)]
    bool notifyDeliveries()
    Returns
    Type Description
    bool

    schedule()

    Declaration
    [ComVisible(true)]
    bool schedule()
    Returns
    Type Description
    bool

    setDeliveryCallback(string, ContentType)

    Declaration
    [ComVisible(true)]
    void setDeliveryCallback(string url, ContentType contentType)
    Parameters
    Type Name Description
    string url
    ContentType contentType

    setMessage(string)

    Declaration
    [ComVisible(true)]
    virtual void setMessage(string message)
    Parameters
    Type Name Description
    string message

    setScheduleDateTime(DateTime, string)

    Declaration
    [ComVisible(false)]
    void setScheduleDateTime(DateTime dateTime, string utcOffset)
    Parameters
    Type Name Description
    DateTime dateTime
    string utcOffset

    setScheduleDateTime(DateTime, string, string)

    Declaration
    [ComVisible(false)]
    void setScheduleDateTime(DateTime dateTime, string region, string city)
    Parameters
    Type Name Description
    DateTime dateTime
    string region
    string city

    setScheduleDateTime(DateTime?)

    Declaration
    [ComVisible(false)]
    void setScheduleDateTime(DateTime? dateTime)
    Parameters
    Type Name Description
    DateTime? dateTime

    setScheduleDateTimeEx(double, string, string)

    Declaration
    [ComVisible(true)]
    void setScheduleDateTimeEx(double dateTime, string p1 = null, string p2 = null)
    Parameters
    Type Name Description
    double dateTime
    string p1
    string p2

    setSender(string)

    Declaration
    [ComVisible(true)]
    virtual void setSender(string sender)
    Parameters
    Type Name Description
    string sender

    validateDestinationSenderName(string)

    Declaration
    [ComVisible(true)]
    void validateDestinationSenderName(string phoneNumber)
    Parameters
    Type Name Description
    string phoneNumber

    Implements

    IComposer
    IMessageComposer
    ISchedule
    Back to top