Revision control
Copy as Markdown
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\qmlmodule QtGrpc
\title Qt GRPC QML Types
\since 6.7
\ingroup qmlmodules
\brief Provides Qt GRPC functionality in QML.
The Qt GRPC Quick module provides the Qt GRPC functionality in QML.
The QML types can be imported into your application using the
following import statement in your .qml file:
\qml
import QtGrpc
\endqml
\section1 QML Types
\generatelist {qmltypesbymodule QtGrpc}
\section1 Related Information
\list
\li \l {magic8ball} {Qt GRPC QML example}
\li \l {The qtgrpcgen Tool} {Qt GRPC QML-types generation}
\li \l{Qt Protobuf QML Types} {Qt Protobuf QML-types generation}
\endlist
\noautolist
*/
/*!
\qmltype GrpcCallOptions
\inqmlmodule QtGrpc
\nativetype QGrpcCallOptions
\brief The GrpcCallOptions is a storage class used to set
additional call options.
Provides a set of properties to access the call options
that are used by \gRPC channels to communicate with the services.
\sa QGrpcCallOptions
*/
/*!
\qmlproperty int GrpcCallOptions::deadlineTimeout
Sets a deadline value for a call.
\sa QGrpcCallOptions::deadlineTimeout
*/
/*!
\qmlproperty GrpcMetadata GrpcCallOptions::metadata
Sets a pointer to the metadata used for a call.
\sa GrpcMetadata
*/
/*!
\qmltype GrpcChannelOptions
\inqmlmodule QtGrpc
\nativetype QGrpcChannelOptions
\brief The GrpcChannelOptions is an storage class used to set
additional channel options.
Provides a set of properties to access the channel
options that are used by \gRPC channels to communicate with the services.
\sa QGrpcChannelOptions
*/
/*!
\qmlproperty int GrpcChannelOptions::deadlineTimeout
Sets a deadline value for a channel.
\sa QGrpcChannelOptions::deadlineTimeout
*/
/*!
\qmlproperty enumeration GrpcChannelOptions::serializationFormat
Sets the serialization format for the channel.
The \l {QtGrpc::SerializationFormat::Default}
format is used by default.
\value QtGrpc.SerializationFormat.Default
\include qtgrpcnamespace.qdoc serialization-format-default
\value QtGrpc.SerializationFormat.Protobuf
\include qtgrpcnamespace.qdoc serialization-format-protobuf
\value QtGrpc.SerializationFormat.Json
\include qtgrpcnamespace.qdoc serialization-format-json
\sa QGrpcChannelOptions::serializationFormat, QtGrpc::SerializationFormat,
QGrpcSerializationFormat
\since 6.8
*/
/*!
\qmlproperty GrpcMetadata GrpcChannelOptions::metadata
Sets a pointer to the metadata object used for a channel.
\sa GrpcMetadata
*/
/*!
\qmltype GrpcMetadata
\inqmlmodule QtGrpc
\brief The GrpcMetadata is a class that stores metadata in unordered
multimap container.
Metadata is information about a particular \gRPC call or channel
(such as authentication details) in the form of a list of key-value pairs,
where the keys are strings and the values are typically strings, but can
be binary data.
The class provides the possibility to store data in an unordered container.
Also, it is possible to store several values by the same key.
\note Use the comma symbol to set several values by the same key.
*/
/*!
\qmlproperty QVariantMap GrpcMetadata::data
Provides access to metadata container and sets it in QVariantMap format
in QML.
\note Data is \c REQUIRED property. It must be set for object creation.
\note Use the comma symbol to set several values by the same key.
See example below:
\code
GrpcMetadata {
id: grpcData
data: ({ "user-name": "localhost, remotehost",
"user-password": "qwerty, 123456"})
}
\endcode
*/
/*!
\qmltype GrpcHttp2Channel
\inqmlmodule QtGrpc
\nativetype QGrpcHttp2Channel
\brief HTTP/2 QML channel.
Implements the QAbstractGrpcChannel interface for HTTP/2 channel type.
It allows to set QGrpcChannelOptions options required for a channel
creation and returns a pointer to the QAbstractGrpcChannel-based object.
\note You can inherit from QGrpcChannelOptions for importing custom
channel in QML.
\sa QGrpcHttp2Channel
*/
/*!
\qmlproperty url GrpcHttp2Channel::hostUri
Sets a host \c URL for the channel.
\note host is \c REQUIRED property. It must be set for object creation.
\sa QGrpcHttp2Channel::hostUri
*/
/*!
\qmlproperty GrpcChannelOptions GrpcHttp2Channel::options
Returns a pointer to the GrpcChannelOptions object.
\sa QGrpcChannelOptions
*/