View source for QOhosSharedRecord Class

< [[Qt_for_HarmonyOS/qtohosextras_doc|Qt for HarmonyOS / qtohosextras doc]]

= QOhosSharedRecord Class =

The QOhosSharedRecord class represents a record to be shared with other application. A record can be created using. [[#details|More...]]

{| class="wikitable"
|-
! Header:
| #include <QOhosSharedRecord>
|-
! qmake:
| QT += ohosextras
|-
! Since:
| Qt 5.12.12
|}

* [[List_of_All_Members_for_QOhosSharedRecord|List of all members, including inherited members]]

== Public Functions ==

{| class="wikitable" style="width:100%"
|-
| virtual || '''[[#dtor.QOhosSharedRecord|~QOhosSharedRecord]]'''()
|-
| virtual QString || '''[[#content|content]]'''() const = 0
|-
| virtual QString || '''[[#description|description]]'''() const = 0
|-
| virtual QVariantMap || '''[[#extraData|extraData]]'''() const = 0
|-
| virtual QString || '''[[#filePath|filePath]]'''() const = 0
|-
| virtual bool || '''[[#isUrlContent|isUrlContent]]'''() const = 0
|-
| virtual QString || '''[[#label|label]]'''() const = 0
|-
| virtual QMimeType || '''[[#mimeType|mimeType]]'''() const = 0
|-
| virtual void || '''[[#setDescription|setDescription]]'''(const QString &''description'') = 0
|-
| virtual void || '''[[#setExtraData|setExtraData]]'''(const QVariantMap &''extraData'') = 0
|-
| virtual void || '''[[#setLabel|setLabel]]'''(const QString &''label'') = 0
|-
| virtual void || '''[[#setThumbnail|setThumbnail]]'''(const QByteArray &''thumbnail'') = 0
|-
| virtual void || '''[[#setThumbnailFilePath|setThumbnailFilePath]]'''(const QString &''thumbnailFilePath'') = 0
|-
| virtual void || '''[[#setTitle|setTitle]]'''(const QString &''title'') = 0
|-
| virtual QByteArray || '''[[#thumbnail|thumbnail]]'''() const = 0
|-
| virtual QString || '''[[#thumbnailFilePath|thumbnailFilePath]]'''() const = 0
|-
| virtual QString || '''[[#title|title]]'''() const = 0
|}

== Protected Functions ==

{| class="wikitable" style="width:100%"
|-
| || '''[[#QOhosSharedRecord|QOhosSharedRecord]]'''()
|}

== Detailed Description ==

<span id="details"></span>
The QOhosSharedRecord class represents a record to be shared with other application. A record can be created using

See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord].

'''See also:''' [[ShareKit_Namespace#createContentRecord|ShareKit::createContentRecord()]], [[ShareKit_Namespace#createFileRecord|ShareKit::createFileRecord()]], or [[ShareKit_Namespace#createUrlRecord|ShareKit::createUrlRecord()]].

== Member Function Documentation ==

=== <span id="QOhosSharedRecord"></span>[protected] QOhosSharedRecord::QOhosSharedRecord() ===

Default constructs an instance of QOhosSharedRecord.

=== <span id="dtor.QOhosSharedRecord"></span>[virtual] QOhosSharedRecord::~QOhosSharedRecord() ===

Destroys the instance of QOhosSharedRecord. The destructor is virtual.

=== <span id="content"></span>[pure virtual] QString QOhosSharedRecord::content() const ===

Gets the shared record optional content. Either content or file path must be set. If there is no content null string is provided. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.content].

=== <span id="description"></span>[pure virtual] QString QOhosSharedRecord::description() const ===

Gets the optional description of the shared record. If there is no description null string is provided. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.description].

'''See also:''' [[#setDescription|setDescription()]].

=== <span id="extraData"></span>[pure virtual] QVariantMap QOhosSharedRecord::extraData() const ===

Gets the optional extra data of the shared record. If there is no extra data empty variant map is provided. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.extraData].

'''See also:''' [[#setExtraData|setExtraData()]].

=== <span id="filePath"></span>[pure virtual] QString QOhosSharedRecord::filePath() const ===

Gets the shared record optional file path. Either content or file path must be set. If there is no file path null string is provided. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.content].

=== <span id="isUrlContent"></span>[pure virtual] bool QOhosSharedRecord::isUrlContent() const ===

Provides information if [[#content|content()]] contains URL string. For URL content the [[#mimeType|mimeType()]] should not be used. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.content].

=== <span id="label"></span>[pure virtual] QString QOhosSharedRecord::label() const ===

Gets the optional label of the shared record. If there is no label null string is provided. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.label].

'''See also:''' [[#setLabel|setLabel()]].

=== <span id="mimeType"></span>[pure virtual] QMimeType QOhosSharedRecord::mimeType() const ===

Gets the shared record associated mime type. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.utd].

=== <span id="setDescription"></span>[pure virtual] void QOhosSharedRecord::setDescription(const QString &description) ===

Sets data record description with a given ''description''. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.description].

'''See also:''' [[#description|description()]].

=== <span id="setExtraData"></span>[pure virtual] void QOhosSharedRecord::setExtraData(const QVariantMap &extraData) ===

Sets extra data for sharing with a given ''extraData''. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.extraData].

'''See also:''' [[#extraData|extraData()]].

=== <span id="setLabel"></span>[pure virtual] void QOhosSharedRecord::setLabel(const QString &label) ===

Sets the label indicating the current data record type with a given ''label''. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.label].

'''See also:''' [[#label|label()]].

=== <span id="setThumbnail"></span>[pure virtual] void QOhosSharedRecord::setThumbnail(const QByteArray &thumbnail) ===

Sets data record thumbnail with a given ''thumbnail''. The thumbnail is an image file content. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.thumbnail].

'''See also:''' [[#thumbnail|thumbnail()]].

=== <span id="setThumbnailFilePath"></span>[pure virtual] void QOhosSharedRecord::setThumbnailFilePath(const QString &thumbnailFilePath) ===

Sets data record thumbnail uri with a given ''thumbnailFilePath''. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.thumbnailUri].

'''See also:''' [[#thumbnailFilePath|thumbnailFilePath()]].

=== <span id="setTitle"></span>[pure virtual] void QOhosSharedRecord::setTitle(const QString &title) ===

Sets the title of shared content with a given ''title''. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.title].

'''See also:''' [[#title|title()]].

=== <span id="thumbnail"></span>[pure virtual] QByteArray QOhosSharedRecord::thumbnail() const ===

Gets the optional thumbnail content of the shared record. If there is no thumbnail empty byte array is provided. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.thumbnail].

'''See also:''' [[#setThumbnail|setThumbnail()]].

=== <span id="thumbnailFilePath"></span>[pure virtual] QString QOhosSharedRecord::thumbnailFilePath() const ===

Gets the optional thumbnail file path of the shared record. If there is no thumbnail file path null string is provided. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.thumbnailFilePath].

'''See also:''' [[#setThumbnailFilePath|setThumbnailFilePath()]].

=== <span id="title"></span>[pure virtual] QString QOhosSharedRecord::title() const ===

Gets the optional title of the shared record. If there is no title null string is provided. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.title].

'''See also:''' [[#setTitle|setTitle()]].

[[Category:Qt for HarmonyOS]]