Release 4.0.0-preview1-00285

[platform/core/csapi/tizenfx.git] / src / Tizen.Tapi / Tizen.Tapi / CallData.cs

/*
 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

using System.Collections.Generic;

namespace Tizen.Tapi
{
    /// <summary>
    /// A class containing information about call idle status notification data.
    /// </summary>
    public class CallIdleStatusNotificationData
    {
        internal uint Id;
        internal CallEndCause Cause;

        internal CallIdleStatusNotificationData()
        {
        }

        /// <summary>
        /// Notification id.
        /// </summary>
        /// <value>Notificatio id in unsigned integer format.</value>
        public uint NotiId
        {
            get
            {
                return Id;
            }
        }

        /// <summary>
        /// End cause for the call indicates whether the call is released normally or due to some other cause.
        /// </summary>
        /// <value>En cause enum value.</value>
        public CallEndCause EndCause
        {
            get
            {
                return Cause;
            }
        }
    }

    /// <summary>
    /// A class which contains calling name information.
    /// </summary>
    public class CallerNameInfo
    {
        internal CallNameMode Mode;
        internal string NameData;

        internal CallerNameInfo()
        {
        }

        /// <summary>
        /// Display mode of the name.
        /// </summary>
        /// <value>Enum value for call name mode</value>
        public CallNameMode NameMode
        {
            get
            {
                return Mode;
            }
        }

        /// <summary>
        /// Calling party name string.
        /// </summary>
        /// <value>String value representing calling party name.</value>
        public string Name
        {
            get
            {
                return NameData;
            }
        }
    }

    /// <summary>
    /// A class which contains details about call information.
    /// </summary>
    public class CallIncomingInfo
    {
        internal uint Handle;
        internal CallType Type;
        internal string Number;
        internal CallerNameInfo Name;
        internal CallCliMode Cli;
        internal CallNoCliCause Cause;
        internal bool IsFwded;
        internal CallActiveLine Line;

        internal CallIncomingInfo()
        {
        }

        /// <summary>
        /// Call handle indicates the handle of the call for the application.
        /// </summary>
        /// <value>Call handle represented in unsigned integer format.</value>
        public uint CallHandle
        {
            get
            {
                return Handle;
            }
        }

        /// <summary>
        /// Call type.
        /// </summary>
        /// <value>Call type indicating whether the requested call is a voice or video call.</value>
        public CallType CallType
        {
            get
            {
                return Type;
            }
        }

        /// <summary>
        /// Caller number, null terminated ASCII.
        /// </summary>
        /// <value>A string representing calling party number.</value>
        public string CallerNumber
        {
            get
            {
                return Number;
            }
        }

        /// <summary>
        /// Call name info. If there is no information from the network, this information will be null.
        /// </summary>
        /// <value>A CallerNameInfo which contains information about the calling party name.</value>
        public CallerNameInfo NameInfo
        {
            get
            {
                return Name;
            }
        }

        /// <summary>
        /// CLI mode.
        /// </summary>
        /// <value>Enum value representing CLI mode.</value>
        public CallCliMode CliMode
        {
            get
            {
                return Cli;
            }
        }

        /// <summary>
        /// No CLI cause.
        /// </summary>
        /// <value>Enum value representing the cause for no CLI.</value>
        public CallNoCliCause CliCause
        {
            get
            {
                return Cause;
            }
        }

        /// <summary>
        /// Checks whether the incoming call is a forwarded call or not.
        /// </summary>
        /// <value>True or false. If the incoming call is a forwarded call, then true else false.</value>
        public bool IsForwarded
        {
            get
            {
                return IsFwded;
            }
        }

        /// <summary>
        /// Current Active Line.
        /// </summary>
        /// <value>Enum value representing call active line.</value>
        public CallActiveLine ActiveLine
        {
            get
            {
                return Line;
            }
        }
    }

    /// <summary>
    /// A class which contains information about call line control.
    /// </summary>
    public class CallRecordLineControl
    {
        internal byte PolarityInc;
        internal byte Toggle;
        internal byte ReversePol;
        internal byte PowerTime;

        internal CallRecordLineControl()
        {
        }

        /// <summary>
        /// Polarity included.
        /// </summary>
        /// <value>Polarity value represented in byte format.</value>
        public byte PolarityIncluded
        {
            get
            {
                return PolarityInc;
            }
        }

        /// <summary>
        /// Toggle mode.
        /// </summary>
        /// <value>Toggle mode represented in byte format.</value>
        public byte ToggleMode
        {
            get
            {
                return Toggle;
            }
        }

        /// <summary>
        /// Reverse polarity.
        /// </summary>
        /// <value>Reverse polarity value represented in byte format.</value>
        public byte ReversePolarity
        {
            get
            {
                return ReversePol;
            }
        }

        /// <summary>
        /// Power denial time.
        /// </summary>
        /// <value>Time value in byte which represents power denial time.</value>
        public byte PowerDenialTime
        {
            get
            {
                return PowerTime;
            }
        }
    }

    /// <summary>
    /// A class which contains information about call record.
    /// </summary>
    public class CallRecord
    {
        internal uint Id;
        internal CallRecordType Type;
        internal string Name;
        internal string Number;
        internal CallRecordLineControl LineCtrl;

        internal CallRecord()
        {
        }

        /// <summary>
        /// Call id
        /// </summary>
        /// <value>Call id which is represented in unsigned integer format.</value>
        public uint CallId
        {
            get
            {
                return Id;
            }
        }

        /// <summary>
        /// Call record type.
        /// </summary>
        /// <value>An enum value representing the call record type.</value>
        public CallRecordType CallRecordType
        {
            get
            {
                return Type;
            }
        }

        /// <summary>
        /// Name record.
        /// </summary>
        /// <remarks>
        /// This value will be filled only if CallRecordType is Name, otherwise it is null.
        /// </remarks>
        /// <value>Name record represented in string.</value>
        public string NameRecord
        {
            get
            {
                return Name;
            }
        }

        /// <summary>
        /// Number record.
        /// </summary>
        /// <remarks>
        /// This value will be filled only if CallRecordType is Record, otherwise it is null.
        /// </remarks>
        /// <value>Number record reprensented in string.</value>
        public string NumberRecord
        {
            get
            {
                return Number;
            }
        }

        /// <summary>
        /// Gets the line control info.
        /// </summary>
        /// <remarks>
        /// This value will be filled only if CallRecordType is LineControl, otherwise it is null.
        /// </remarks>
        /// <value>An instance of CallRecordLineControl class.</value>
        public CallRecordLineControl LineControlInfo
        {
            get
            {
                return LineCtrl;
            }
        }
    }

    /// <summary>
    /// A class which contains information about call signal notification.
    /// </summary>
    public class CallSignalNotification
    {
        internal CallAlertSignal Signal;
        internal CallAlertPitch Pitch;
        internal CallToneSignal Tone;
        internal CallIsdnAlertSignal Isdn;
        internal CallIs54bAlertSignal Is54b;

        internal CallSignalNotification()
        {
        }

        /// <summary>
        /// Gets the call signal type.
        /// </summary>
        /// <value>Signal type of the call represented as CallAlertSignal enum.</value>
        public CallAlertSignal SignalType
        {
            get
            {
                return Signal;
            }
        }

        /// <summary>
        /// Gets the call pitch type.
        /// </summary>
        /// <value>Pitch type of the call represented as CallAlertPitch enum.</value>
        public CallAlertPitch PitchType
        {
            get
            {
                return Pitch;
            }
        }

        /// <summary>
        /// Gets the call signal tone type.
        /// </summary>
        /// <remarks>
        /// This value will be filled only if SignalType is Tone.
        /// </remarks>
        /// <value>Signal tone type of the call represented in CallToneSignal enum.</value>
        public CallToneSignal ToneType
        {
            get
            {
                return Tone;
            }
        }

        /// <summary>
        /// Gets the signal ISDN Alert type.
        /// </summary>
        /// <remarks>
        /// This value will be filled only if SignalType is IsdnAlert.
        /// </remarks>
        /// <value>Signal ISDN alert type of the call represented in CallIsdnAlertSignal enum.</value>
        public CallIsdnAlertSignal IsdnAlertType
        {
            get
            {
                return Isdn;
            }
        }

        /// <summary>
        /// Gets the signal IS54B alert type.
        /// </summary>
        /// <remarks>
        /// This value will be filled only if SignalType is Is54bAlert.
        /// </remarks>
        /// <value>Signal IS54B alerty type of the call represented in CallIs54bAlertSignal enum.</value>
        public CallIs54bAlertSignal Is54bAlertType
        {
            get
            {
                return Is54b;
            }
        }
    }

    /// <summary>
    /// A class which contains information about call upgrade/downgrade request of VoLTE call.
    /// </summary>
    public class CallUpgradeDowngradeRequestNoti
    {
        internal int Handle;
        internal CallConfigType Type;

        internal CallUpgradeDowngradeRequestNoti()
        {
        }

        /// <summary>
        /// Gets the call handle.
        /// </summary>
        /// <value>Call handle value represented in integer format.</value>
        public int CallHandle
        {
            get
            {
                return Handle;
            }
        }

        /// <summary>
        /// Gets the call upgrade/downgrade config type.
        /// </summary>
        /// <value>Call upgrade/downgrade type represented in CallConfigType enum.</value>
        public CallConfigType UpgradeType
        {
            get
            {
                return Type;
            }
        }
    }

    /// <summary>
    /// A class which contains information about an outgoing call.
    /// </summary>
    public class CallInformation
    {
        private CallType _type;
        private EmergencyType _etype;
        private string _number;
        private CallInformation()
        {
        }

        /// <summary>
        /// A parameterized constructor of CallInformation.
        /// </summary>
        /// <param name="type">Type of call(voice, data, video, emergency).</param>
        /// <param name="etype">Emergency category.</param>
        /// <param name="phoneNumber">Destination phone number.</param>
        public CallInformation(CallType type, EmergencyType etype, string phoneNumber)
        {
            _type = type;
            _etype = etype;
            _number = phoneNumber;
        }

        internal CallType Type
        {
            get
            {
                return _type;
            }
        }

        internal EmergencyType EType
        {
            get
            {
                return _etype;
            }
        }

        internal string PhoneNumber
        {
            get
            {
                return _number;
            }
        }
    }

    /// <summary>
    /// A class which contains information about call end response data.
    /// </summary>
    public class CallEndData
    {
        private CallEndType _type;
        private uint _id;

        private CallEndData()
        {
        }

        internal CallEndData(CallEndType type, uint id)
        {
            _type = type;
            _id = id;
        }

        /// <summary>
        /// End type.
        /// </summary>
        public CallEndType Type
        {
            get
            {
                return _type;
            }
        }

        /// <summary>
        /// Id.
        /// </summary>
        public uint Id
        {
            get
            {
                return _id;
            }
        }
    }

    /// <summary>
    /// A class which contains information about burst DTMF in CDMA.
    /// </summary>
    public class CallBurstDtmfData
    {
        private string _dtmf;
        private CallDtmfPulseWidth _width;
        private CallDtmfDigitInterval _interval;

        private CallBurstDtmfData()
        {
        }

        /// <summary>
        /// A parameterized constructor of CallBurstDtmfData.
        /// </summary>
        /// <param name="dtmf">Burst DTMF string.</param>
        /// <param name="width">DTMF Pulse Width.</param>
        /// <param name="interval">DTMF Inter Digit Interval.</param>
        public CallBurstDtmfData(string dtmf, CallDtmfPulseWidth width, CallDtmfDigitInterval interval)
        {
            _dtmf = dtmf;
            _width = width;
            _interval = interval;
        }

        internal string Dtmf
        {
            get
            {
                return _dtmf;
            }
        }

        internal CallDtmfPulseWidth Width
        {
            get
            {
                return _width;
            }
        }

        internal CallDtmfDigitInterval Interval
        {
            get
            {
                return _interval;
            }
        }
    }

    /// <summary>
    /// A class which contains information about call status.
    /// </summary>
    public class CallStatus
    {
        private int _handle;
        private bool _isMoCall;
        private string _number;
        private CallType _type;
        private CallState _state;
        private bool _isConferenceState;
        private bool _isVolteCall;
        internal CallStatus()
        {
        }

        /// <summary>
        /// Call handle.
        /// </summary>
        public int CallHandle
        {
            get
            {
                return _handle;
            }

            internal set
            {
                _handle = value;
            }
        }

        /// <summary>
        /// Status will be true for MO calls. If MT call, then its false.
        /// </summary>
        public bool IsMoCall
        {
            get
            {
                return _isMoCall;
            }

            internal set
            {
                _isMoCall = value;
            }
        }

        /// <summary>
        /// Mobile number.
        /// </summary>
        public string PhoneNumber
        {
            get
            {
                return _number;
            }

            internal set
            {
                _number = value;
            }
        }

        /// <summary>
        /// Type of call(voice, data, emergency).
        /// </summary>
        public CallType Type
        {
            get
            {
                return _type;
            }

            internal set
            {
                _type = value;
            }
        }

        /// <summary>
        /// Current call state.
        /// </summary>
        public CallState State
        {
            get
            {
                return _state;
            }

            internal set
            {
                _state = value;
            }
        }

        /// <summary>
        /// Whether call is in conference state.
        /// </summary>
        public bool IsConferenceState
        {
            get
            {
                return _isConferenceState;
            }

            internal set
            {
                _isConferenceState = value;
            }
        }

        /// <summary>
        /// Whether call is volte call.
        /// </summary>
        public bool IsVolteCall
        {
            get
            {
                return _isVolteCall;
            }

            internal set
            {
                _isVolteCall = value;
            }
        }
    }

    /// <summary>
    /// A class that contains call volume info.
    /// </summary>
    public class CallVolumeRecord
    {
        private SoundDevice _device;
        private SoundType _type;
        private SoundVolume _volume;
        private CallVolumeRecord()
        {
        }

        /// <summary>
        /// A parameterized constructor of CallVolumeRecord.
        /// </summary>
        /// <param name="device">Call sound device.</param>
        /// <param name="type">Call sound type.</param>
        /// <param name="volume">Call sound volume.</param>
        public CallVolumeRecord(SoundDevice device, SoundType type, SoundVolume volume)
        {
            _device = device;
            _type = type;
            _volume = volume;
        }

        /// <summary>
        /// Call sound device info.
        /// </summary>
        public SoundDevice Device
        {
            get
            {
                return _device;
            }
        }

        /// <summary>
        /// Call sound type info.
        /// </summary>
        public SoundType Type
        {
            get
            {
                return _type;
            }
        }

        /// <summary>
        /// Call sound volume info.
        /// </summary>
        public SoundVolume Volume
        {
            get
            {
                return _volume;
            }
        }
    }

    /// <summary>
    /// A class which contains call volume info reponse data.
    /// </summary>
    public class CallVolumeInfo
    {
        private uint _id;
        private IEnumerable<CallVolumeRecord> _recordList;

        private CallVolumeInfo()
        {
        }

        internal CallVolumeInfo(uint id, IEnumerable<CallVolumeRecord> list)
        {
            _id = id;
            _recordList = list;
        }

        /// <summary>
        /// Record number.
        /// </summary>
        public uint RecordId
        {
            get
            {
                return _id;
            }
        }

        /// <summary>
        /// Volume info record.
        /// </summary>
        public IEnumerable<CallVolumeRecord> Records
        {
            get
            {
                return _recordList;
            }
        }
    }

    /// <summary>
    /// A class which contains call sound path and volume information.
    /// </summary>
    public class CallSoundPathInfo
    {
        private SoundPath _path;
        private ExtraVolume _exVolume;
        private CallSoundPathInfo()
        {
        }

        /// <summary>
        /// A parameterized constructor of CallSoundPathInfo.
        /// </summary>
        /// <param name="path">Sound path.</param>
        /// <param name="exVolume">Extra volume status.</param>
        public CallSoundPathInfo(SoundPath path, ExtraVolume exVolume)
        {
            _path = path;
            _exVolume = exVolume;
        }

        internal SoundPath Path
        {
            get
            {
                return _path;
            }
        }

        internal ExtraVolume ExVolume
        {
            get
            {
                return _exVolume;
            }
        }
    }

    /// <summary>
    /// A class which contains call mute status reponse data.
    /// </summary>
    public class CallMuteStatusRecord
    {
        private SoundMutePath _path;
        private SoundMuteStatus _status;
        private CallMuteStatusRecord()
        {
        }

        /// <summary>
        /// A parameterized constructor of CallMuteStatusRecord.
        /// </summary>
        /// <param name="path">Mute path.</param>
        /// <param name="status">Mute status.</param>
        public CallMuteStatusRecord(SoundMutePath path, SoundMuteStatus status)
        {
            _path = path;
            _status = status;
        }

        /// <summary>
        /// Gets the sound mute path.
        /// </summary>
        public SoundMutePath Path
        {
            get
            {
                return _path;
            }
        }

        /// <summary>
        /// Gets the sound mute status.
        /// </summary>
        public SoundMuteStatus Status
        {
            get
            {
                return _status;
            }
        }
    }
}