Member Type Documentation

QAndroidBroadcastTransmitter::BundleFunctor

This is a typedef for a special type of function used to convert data from a QVariant representation to a Bundle referred to by a QJniObject.

The function should return true when it has finished converting the given value, or false if the function should or could not be used to convert the value. This means that if the user does not want the given value to be converted at all, they may return false without adding any data to the given QJniObject.

The first argument will be a reference to a QJniObject representation of an Android Bundle.

The second argument will be the QVariant data that should be converted. This data may be the entire QVariantMap passed from sendBroadcast() or a single QVariant from that QVariantMap.

Users may detect whether the argument is a QVariant or a QVariantMap by using the QVariant::metaType() method and the qMetaTypeId macro like so:

QVariant variant = QVariantMap();
if (variant.metaType().id() == qMetaTypeId<QVariantMap>()) {
    // QVariant variable contains a QVariantMap.
}

The third argument will be the path of keys from the root of the QVariantMap to the current value, or empty if the passed QVariant data is the full QVariantMap data passed to sendBroadcast().

This code snippet shows a BundleFunctor being used to write the year, month and day from a QDate contained inside a QVariant into an Android Bundle which is then written into the bundle provided by QAndroidBroadcastTransmitter. This way we can contain all the required date data inside a single Bundle, identified via the key "date".

Note that when we're done processing the QDate, we return true in order to make sure that the default converter functions are not used on this data.

Q_DECLARE_JNI_CLASS(AndroidBundle, "android/os/Bundle")

const QAndroidBroadcastTransmitter::BundleFunctor dateConverter = [] (
        QJniObject &bundle,
        const QVariant &variant,
        const QStringList &keys) {
    if (keys.empty() || keys.last() != "date")
        return false;

    if (variant.metaType().id() != qMetaTypeId<QDate>())
        return false;

    QJniObject dateBundle(QtJniTypes::className<QtJniTypes::AndroidBundle>());
    QDate date = variant.toDate();

    const auto yearKey = QJniObject::fromString("year");
    const auto yearString = yearKey.object<jstring>();
    dateBundle.callMethod<void>("putInt", yearString, date.year());

    const auto monthKey = QJniObject::fromString("month");
    const auto monthString = monthKey.object<jstring>();
    dateBundle.callMethod<void>("putInt", monthString, date.month());

    const auto dayKey = QJniObject::fromString("day");
    const auto dayString = dayKey.object<jstring>();
    dateBundle.callMethod<void>("putInt", dayString, date.day());

    const auto dateKey = QJniObject::fromString("date");
    const auto dateString = dateKey.object<jstring>();
    bundle.callMethod<void>("putBundle",
                            dateString,
                            dateBundle.object<QtJniTypes::AndroidBundle>());

    return true;
};

See also setBundleFunctor().