src/Tizen.Tapi/Tizen.Tapi/NetworkEnumerations.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 namespace Tizen.Tapi
  18 {
  19     /// <summary>
  20     /// Enumeration for the status of the network service.
  21     /// </summary>
  22     public enum NetworkServiceLevel
  23     {
  24         /// <summary>
  25         /// No service available in the network ME is camped.
  26         /// </summary>
  27         No,
  28         /// <summary>
  29         /// Only emergency service available in the network ME is camped.
  30         /// </summary>
  31         Emergency,
  32         /// <summary>
  33         /// FULL service available in the network ME is camped
  34         /// </summary>
  35         Full,
  36         /// <summary>
  37         /// Searching for service.
  38         /// </summary>
  39         Search
  40     }
  41
  42     /// <summary>
  43     /// Enumeration for the service types of TAPI.
  44     /// </summary>
  45     public enum NetworkServiceType
  46     {
  47         /// <summary>
  48         /// Service type is Unknown.
  49         /// </summary>
  50         Unknown = 0x0,
  51         /// <summary>
  52         /// No Service available.
  53         /// </summary>
  54         NoService,
  55         /// <summary>
  56         /// Service type is Emergency.
  57         /// </summary>
  58         Emergency,
  59         /// <summary>
  60         /// Service type is Searching.
  61         /// </summary>
  62         Search,
  63         /// <summary>
  64         /// Service type is 2G. In case of CDMA, service type is set to 2G when System Type is IS95A/IS95B/CDMA_1X.
  65         /// </summary>
  66         Type2G,
  67         /// <summary>
  68         /// Service type is 2.5G.
  69         /// </summary>
  70         Type2And5G,
  71         /// <summary>
  72         /// Service type is 2.5G (EDGE).
  73         /// </summary>
  74         TypeAnd5GEdge,
  75         /// <summary>
  76         /// Service type is 3G. In case of CDMA, service type is set to 3G when System Type is EVDO_REV_0/REV_A/REV_B/EHRPD.
  77         /// </summary>
  78         Type3G,
  79         /// <summary>
  80         /// Service type is HSDPA.
  81         /// </summary>
  82         Hsdpa,
  83         /// <summary>
  84         /// Service type is LTE.
  85         /// </summary>
  86         Lte
  87     }
  88
  89     /// <summary>
  90     /// Enumeration for the system types of network.
  91     /// </summary>
  92     public enum NetworkSystemType
  93     {
  94         /// <summary>
  95         /// No Service available.
  96         /// </summary>
  97         NoService = 0x01,
  98         /// <summary>
  99         /// Available service is GSM.
 100         /// </summary>
 101         Gsm,
 102         /// <summary>
 103         /// Available service is GPRS.
 104         /// </summary>
 105         Gprs,
 106         /// <summary>
 107         /// Available service is EGPRS.
 108         /// </summary>
 109         EGprs,
 110         /// <summary>
 111         /// Available service is PCS1900 band.
 112         /// </summary>
 113         Pcs1900,
 114         /// <summary>
 115         /// Available service is UMTS.
 116         /// </summary>
 117         Umts,
 118         /// <summary>
 119         /// Both GSM and UMTS systems available.
 120         /// </summary>
 121         GsmandUmts,
 122         /// <summary>
 123         /// Available service is HSDPA.
 124         /// </summary>
 125         Hsdpa,
 126         /// <summary>
 127         /// Available service is IS95A.
 128         /// </summary>
 129         Is95A,
 130         /// <summary>
 131         /// Available service is IS95B.
 132         /// </summary>
 133         Is95B,
 134         /// <summary>
 135         /// Available service is CDMA 1X.
 136         /// </summary>
 137         Cdma1x,
 138         /// <summary>
 139         /// Available service is EV-DO rev0.
 140         /// </summary>
 141         EvdoRev0,
 142         /// <summary>
 143         /// Available service is 1X and EV-DO rev0.
 144         /// </summary>
 145         Hybrid1xandEvdoRev0,
 146         /// <summary>
 147         /// Available service is EV-DO revA.
 148         /// </summary>
 149         EvdoRevA,
 150         /// <summary>
 151         /// Available service is 1X and EV-DO revA.
 152         /// </summary>
 153         Hybrid1xandEvdoRevA,
 154         /// <summary>
 155         /// Available service is EV-DO revB.
 156         /// </summary>
 157         EvdoRevB,
 158         /// <summary>
 159         /// Available service is 1X and EV-DO revB.
 160         /// </summary>
 161         Hybrid1xandEvdoRevB,
 162         /// <summary>
 163         /// Available service is EV-DV.
 164         /// </summary>
 165         Evdv,
 166         /// <summary>
 167         /// Available service is EHRPD.
 168         /// </summary>
 169         Ehrpd,
 170         /// <summary>
 171         /// Available service is LTE.
 172         /// </summary>
 173         Lte
 174     }
 175
 176     /// <summary>
 177     /// Enumeration for the network emergency callback mode states (3GPP2 specific enum).
 178     /// </summary>
 179     public enum NetworkEmergencyCallbackMode
 180     {
 181         /// <summary>
 182         /// Enter emergency callback mode.
 183         /// </summary>
 184         Enter,
 185         /// <summary>
 186         /// Exit emergency callback mode.
 187         /// </summary>
 188         Exit
 189     }
 190
 191     /// <summary>
 192     /// Enumeration for the possible default Data Subscriptions.
 193     /// </summary>
 194     public enum NetworkDefaultDataSubscription
 195     {
 196         /// <summary>
 197         /// Unknown status.
 198         /// </summary>
 199         Unknown = -1,
 200         /// <summary>
 201         /// SIM 1.
 202         /// </summary>
 203         Sim1 = 0,
 204         /// <summary>
 205         /// SIM 2.
 206         /// </summary>
 207         Sim2
 208     }
 209
 210     /// <summary>
 211     /// Enumeration for the possible default Subscriptions for CS (Voice).
 212     /// </summary>
 213     public enum NetworkDefaultSubscription
 214     {
 215         /// <summary>
 216         /// Unknown status.
 217         /// </summary>
 218         Unknown = -1,
 219         /// <summary>
 220         /// SIM 1 network.
 221         /// </summary>
 222         Sim1 = 0,
 223         /// <summary>
 224         /// SIM 2 network.
 225         /// </summary>
 226         Sim2
 227     }
 228
 229     /// <summary>
 230     /// Enumeration for type of network on which VoLTE is registered.
 231     /// </summary>
 232     public enum VolteNetworkType
 233     {
 234         /// <summary>
 235         /// Unknown.
 236         /// </summary>
 237         Unknown,
 238         /// <summary>
 239         /// Mobile.
 240         /// </summary>
 241         Mobile,
 242         /// <summary>
 243         /// WiFi.
 244         /// </summary>
 245         Wifi
 246     }
 247
 248     /// <summary>
 249     /// Enumeration for the packet service protocol type.
 250     /// </summary>
 251     public enum NetworkPsType
 252     {
 253         /// <summary>
 254         /// Unknown PS type.
 255         /// </summary>
 256         Unknown,
 257         /// <summary>
 258         /// HSDPA.
 259         /// </summary>
 260         Hsdpa,
 261         /// <summary>
 262         /// HSUPA.
 263         /// </summary>
 264         Hsupa,
 265         /// <summary>
 266         /// HSPA.
 267         /// </summary>
 268         Hspa,
 269         /// <summary>
 270         /// HSPAP.
 271         /// </summary>
 272         Hspap
 273     }
 274
 275     /// <summary>
 276     /// Enumeration for the network name display condition type.
 277     /// </summary>
 278     public enum NetworkNameDisplayCondition
 279     {
 280         /// <summary>
 281         /// Invalid Display Condition.
 282         /// </summary>
 283         Invalid = 0x00,
 284         /// <summary>
 285         /// Display Condition is SPN.
 286         /// </summary>
 287         Spn = 0x01,
 288         /// <summary>
 289         /// Display Condition is PLMN.
 290         /// </summary>
 291         Plmn = 0x02,
 292         /// <summary>
 293         /// Display Condition is SPN or PLMN.
 294         /// </summary>
 295         SpnOrPlmn = 0x03
 296     }
 297
 298     /// <summary>
 299     /// Enumeration for the different serving network LTE  band type.
 300     /// </summary>
 301     public enum NetworkLteBandType
 302     {
 303         /// <summary>
 304         /// Unknown.
 305         /// </summary>
 306         Unknown = 0x00,
 307         /// <summary>
 308         /// FDD.
 309         /// </summary>
 310         Fdd,
 311         /// <summary>
 312         /// TDD.
 313         /// </summary>
 314         Tdd
 315     }
 316
 317     /// <summary>
 318     /// Enumeration for the operation that can be done on a preferred PLMN.
 319     /// </summary>
 320     public enum NetworkPreferredPlmnOp
 321     {
 322         /// <summary>
 323         /// Addition to the Network Preferred PLMN list.
 324         /// </summary>
 325         Add = 0x01,
 326         /// <summary>
 327         /// Edit the network Preferred PLMN list.
 328         /// </summary>
 329         Edit,
 330         /// <summary>
 331         /// Delete the entry to the network Preferred PLMN list.
 332         /// </summary>
 333         Delete
 334     }
 335
 336     /// <summary>
 337     /// Enumeration for the CDMA Preferred Network Type(CDMA only).
 338     /// </summary>
 339     public enum NetworkPreferred
 340     {
 341         /// <summary>
 342         /// Home only.
 343         /// </summary>
 344         HomeOnly,
 345         /// <summary>
 346         /// Affiliated.
 347         /// </summary>
 348         Affiliated,
 349         /// <summary>
 350         /// Automatic.
 351         /// </summary>
 352         Automatic,
 353         /// <summary>
 354         /// Automatic-A.
 355         /// </summary>
 356         AutomaticA,
 357         /// <summary>
 358         /// Automatic-B.
 359         /// </summary>
 360         AutomaticB,
 361         /// <summary>
 362         /// Roam domestic.
 363         /// </summary>
 364         RoamDomestic,
 365         /// <summary>
 366         /// Roam international.
 367         /// </summary>
 368         RoamInternational,
 369         /// <summary>
 370         /// Roam dual.
 371         /// </summary>
 372         RoamDual,
 373         /// <summary>
 374         /// Blank.
 375         /// </summary>
 376         Blank
 377     }
 378
 379     /// <summary>
 380     /// Enumeration for the different network operation causes.
 381     /// </summary>
 382     public enum NetworkOperationCause
 383     {
 384         /// <summary>
 385         /// No error for any operation.
 386         /// </summary>
 387         NoError,
 388         /// <summary>
 389         /// Aborted.
 390         /// </summary>
 391         Aborted,
 392         /// <summary>
 393         /// Error.
 394         /// </summary>
 395         Failed,
 396         /// <summary>
 397         /// Phone is in use(eg: Voice / Data call in progress).
 398         /// </summary>
 399         PhoneInUse,
 400         /// <summary>
 401         /// Phone is in offline mode.
 402         /// </summary>
 403         Offline,
 404         /// <summary>
 405         /// Modem is unable to process the config settings information.
 406         /// </summary>
 407         ConfigSettingsFailure,
 408         /// <summary>
 409         /// Internal failure.
 410         /// </summary>
 411         InternalFailure,
 412         /// <summary>
 413         /// Memory is full.
 414         /// </summary>
 415         MemoryFull
 416     }
 417
 418     /// <summary>
 419     /// Enumeration for the network plmn type.
 420     /// </summary>
 421     public enum NetworkPlmnType
 422     {
 423         /// <summary>
 424         /// Unknown.
 425         /// </summary>
 426         Unknown,
 427         /// <summary>
 428         /// Home plmn.
 429         /// </summary>
 430         Home,
 431         /// <summary>
 432         /// Available.
 433         /// </summary>
 434         Available,
 435         /// <summary>
 436         /// Forbidden.
 437         /// </summary>
 438         Forbidden
 439     }
 440
 441     /// <summary>
 442     /// Enumeration for the network selection mode.
 443     /// </summary>
 444     public enum NetworkSelectionMode
 445     {
 446         /// <summary>
 447         /// Automatic selection mode.
 448         /// </summary>
 449         Auto,
 450         /// <summary>
 451         /// Manual selection mode (Not applicable to CDMA).
 452         /// </summary>
 453         Manual
 454     }
 455
 456     /// <summary>
 457     /// Enumeration for the different network modes.
 458     /// </summary>
 459     public enum NetworkMode
 460     {
 461         /// <summary>
 462         /// Auto.
 463         /// </summary>
 464         Auto = 0x00,
 465         /// <summary>
 466         /// Gsm.
 467         /// </summary>
 468         Gsm = 0x01,
 469         /// <summary>
 470         /// Wcdma.
 471         /// </summary>
 472         Wcdma = 0x02,
 473         /// <summary>
 474         /// Rtt1x.
 475         /// </summary>
 476         Rtt1x = 0x04,
 477         /// <summary>
 478         /// Lte.
 479         /// </summary>
 480         Lte = 0x08,
 481         /// <summary>
 482         /// Evdo.
 483         /// </summary>
 484         Evdo = 0x10,
 485         /// <summary>
 486         /// Cdma.
 487         /// </summary>
 488         Cdma = 0x14
 489     }
 490 }