radio/aidl/android/hardware/radio/messaging/CdmaSmsAddress.aidl

/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * 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.
 */

package android.hardware.radio.messaging;

/** @hide */
@VintfStability
@JavaDerive(toString=true)
parcelable CdmaSmsAddress {
    /**
     * DTMF digits
     */
    const int DIGIT_MODE_FOUR_BIT = 0;
    const int DIGIT_MODE_EIGHT_BIT = 1;

    const int NUMBER_PLAN_UNKNOWN = 0;
    /**
     * CCITT E.164 and E.163, including ISDN plan
     */
    const int NUMBER_PLAN_TELEPHONY = 1;
    const int NUMBER_PLAN_RESERVED_2 = 2;
    /**
     * CCITT X.121
     */
    const int NUMBER_PLAN_DATA = 3;
    /**
     * CCITT F.69
     */
    const int NUMBER_PLAN_TELEX = 4;
    const int NUMBER_PLAN_RESERVED_5 = 5;
    const int NUMBER_PLAN_RESERVED_6 = 6;
    const int NUMBER_PLAN_RESERVED_7 = 7;
    const int NUMBER_PLAN_RESERVED_8 = 8;
    const int NUMBER_PLAN_PRIVATE = 9;
    const int NUMBER_PLAN_RESERVED_10 = 10;
    const int NUMBER_PLAN_RESERVED_11 = 11;
    const int NUMBER_PLAN_RESERVED_12 = 12;
    const int NUMBER_PLAN_RESERVED_13 = 13;
    const int NUMBER_PLAN_RESERVED_14 = 14;
    const int NUMBER_PLAN_RESERVED_15 = 15;

    const int NUMBER_TYPE_UNKNOWN = 0;
    /**
     * INTERNATIONAL is used when number mode is not data network address. DATA_IP is used when the
     * number mode is data network address.
     */
    const int NUMBER_TYPE_INTERNATIONAL_OR_DATA_IP = 1;
    /**
     * NATIONAL is used when the number mode is not data netework address. INTERNET_MAIL is used
     * when the number mode is data network address. For INTERNET_MAIL, in the address data
     * "digits", each byte contains an ASCII character. Examples are: "x@y.com,a@b.com"
     * Ref TIA/EIA-637A 3.4.3.3
     */
    const int NUMBER_TYPE_NATIONAL_OR_INTERNET_MAIL = 2;
    const int NUMBER_TYPE_NETWORK = 3;
    const int NUMBER_TYPE_SUBSCRIBER = 4;
    /**
     * GSM SMS: address value is GSM 7-bit chars
     */
    const int NUMBER_TYPE_ALPHANUMERIC = 5;
    const int NUMBER_TYPE_ABBREVIATED = 6;
    const int NUMBER_TYPE_RESERVED_7 = 7;

    /**
     * CdmaSmsDigitMode is of two types : 4 bit and 8 bit.
     * For 4-bit type, only "digits" field defined below in this struct is used.
     * Values are DIGIT_MODE_
     */
    int digitMode;
    /**
     * Used only when digitMode is 8-bit.
     */
    boolean isNumberModeDataNetwork;
    /**
     * Used only when digitMode is 8-bit. To specify an international address, use the following:
     * digitMode = EIGHT_BIT
     * isNumberModeDataNetwork = true
     * numberType = INTERNATIONAL_OR_DATA_IP
     * numberPlan = TELEPHONY
     * digits = ASCII digits, e.g. '1', '2', '3', '4', and '5'
     * Values are NUMBER_TYPE_
     */
    int numberType;
    /**
     * Used only when digitMode is 8-bit.
     * Values are NUMBER_PLAN_
     */
    int numberPlan;
    /**
     * Each byte in this array represents a 4 bit or 8-bit digit of address data.
     */
    byte[] digits;
}