mirror of
https://github.com/Qortal/qortal.git
synced 2025-03-19 05:24:58 +00:00
Q-Apps documentation updates.
This commit is contained in:
parent
3f71a63512
commit
92b983a16e
65
Q-Apps.md
65
Q-Apps.md
@ -42,6 +42,9 @@ A "default" resource refers to one without an identifier. For example, when a we
|
|||||||
|
|
||||||
Here is a list of currently available services that can be used in Q-Apps:
|
Here is a list of currently available services that can be used in Q-Apps:
|
||||||
|
|
||||||
|
### Public services ###
|
||||||
|
The services below are intended to be used for publicly accessible data.
|
||||||
|
|
||||||
IMAGE,
|
IMAGE,
|
||||||
THUMBNAIL,
|
THUMBNAIL,
|
||||||
VIDEO,
|
VIDEO,
|
||||||
@ -83,6 +86,20 @@ QCHAT_IMAGE,
|
|||||||
QCHAT_AUDIO,
|
QCHAT_AUDIO,
|
||||||
QCHAT_VOICE
|
QCHAT_VOICE
|
||||||
|
|
||||||
|
### Private services ###
|
||||||
|
For the services below, data is encrypted for a single recipient, and can only be decrypted using the private key of the recipient's wallet.
|
||||||
|
|
||||||
|
QCHAT_ATTACHMENT_PRIVATE
|
||||||
|
ATTACHMENT_PRIVATE
|
||||||
|
FILE_PRIVATE
|
||||||
|
IMAGE_PRIVATE
|
||||||
|
VIDEO_PRIVATE
|
||||||
|
AUDIO_PRIVATE
|
||||||
|
VOICE_PRIVATE
|
||||||
|
DOCUMENT_PRIVATE
|
||||||
|
MAIL_PRIVATE
|
||||||
|
MESSAGE_PRIVATE
|
||||||
|
|
||||||
|
|
||||||
## Single vs multi-file resources
|
## Single vs multi-file resources
|
||||||
|
|
||||||
@ -246,6 +263,8 @@ Here is a list of currently supported actions:
|
|||||||
- FETCH_QDN_RESOURCE
|
- FETCH_QDN_RESOURCE
|
||||||
- PUBLISH_QDN_RESOURCE
|
- PUBLISH_QDN_RESOURCE
|
||||||
- PUBLISH_MULTIPLE_QDN_RESOURCES
|
- PUBLISH_MULTIPLE_QDN_RESOURCES
|
||||||
|
- DECRYPT_DATA
|
||||||
|
- SAVE_FILE
|
||||||
- GET_WALLET_BALANCE
|
- GET_WALLET_BALANCE
|
||||||
- GET_BALANCE
|
- GET_BALANCE
|
||||||
- SEND_COIN
|
- SEND_COIN
|
||||||
@ -435,7 +454,7 @@ let res = await qortalRequest({
|
|||||||
_Requires user approval_.<br />
|
_Requires user approval_.<br />
|
||||||
Note: this publishes a single, base64-encoded file. Multi-file resource publishing (such as a WEBSITE or GIF_REPOSITORY) is not yet supported via a Q-App. It will be added in a future update.
|
Note: this publishes a single, base64-encoded file. Multi-file resource publishing (such as a WEBSITE or GIF_REPOSITORY) is not yet supported via a Q-App. It will be added in a future update.
|
||||||
```
|
```
|
||||||
await qortalRequest({
|
let res = await qortalRequest({
|
||||||
action: "PUBLISH_QDN_RESOURCE",
|
action: "PUBLISH_QDN_RESOURCE",
|
||||||
name: "Demo", // Publisher must own the registered name - use GET_ACCOUNT_NAMES for a list
|
name: "Demo", // Publisher must own the registered name - use GET_ACCOUNT_NAMES for a list
|
||||||
service: "IMAGE",
|
service: "IMAGE",
|
||||||
@ -449,7 +468,9 @@ await qortalRequest({
|
|||||||
// tag2: "strings", // Optional
|
// tag2: "strings", // Optional
|
||||||
// tag3: "can", // Optional
|
// tag3: "can", // Optional
|
||||||
// tag4: "go", // Optional
|
// tag4: "go", // Optional
|
||||||
// tag5: "here" // Optional
|
// tag5: "here", // Optional
|
||||||
|
// encrypt: true, // Optional - to be used with a private service
|
||||||
|
// recipientPublicKey: "publickeygoeshere" // Only required if `encrypt` is set to true
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -457,7 +478,7 @@ await qortalRequest({
|
|||||||
_Requires user approval_.<br />
|
_Requires user approval_.<br />
|
||||||
Note: each resource being published consists of a single, base64-encoded file, each in its own transaction. Useful for publishing two or more related things, such as a video and a video thumbnail.
|
Note: each resource being published consists of a single, base64-encoded file, each in its own transaction. Useful for publishing two or more related things, such as a video and a video thumbnail.
|
||||||
```
|
```
|
||||||
await qortalRequest({
|
let res = await qortalRequest({
|
||||||
action: "PUBLISH_MULTIPLE_QDN_RESOURCES",
|
action: "PUBLISH_MULTIPLE_QDN_RESOURCES",
|
||||||
resources: [
|
resources: [
|
||||||
name: "Demo", // Publisher must own the registered name - use GET_ACCOUNT_NAMES for a list
|
name: "Demo", // Publisher must own the registered name - use GET_ACCOUNT_NAMES for a list
|
||||||
@ -472,7 +493,9 @@ await qortalRequest({
|
|||||||
// tag2: "strings", // Optional
|
// tag2: "strings", // Optional
|
||||||
// tag3: "can", // Optional
|
// tag3: "can", // Optional
|
||||||
// tag4: "go", // Optional
|
// tag4: "go", // Optional
|
||||||
// tag5: "here" // Optional
|
// tag5: "here", // Optional
|
||||||
|
// encrypt: true, // Optional - to be used with a private service
|
||||||
|
// recipientPublicKey: "publickeygoeshere" // Only required if `encrypt` is set to true
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
... more resources here if needed ...
|
... more resources here if needed ...
|
||||||
@ -480,10 +503,32 @@ await qortalRequest({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Decrypt encrypted/private data
|
||||||
|
```
|
||||||
|
let res = await qortalRequest({
|
||||||
|
action: "DECRYPT_DATA",
|
||||||
|
encryptedData: 'qortalEncryptedDatabMx4fELNTV+ifJxmv4+GcuOIJOTo+3qAvbWKNY2L1r',
|
||||||
|
publicKey: 'publickeygoeshere'
|
||||||
|
});
|
||||||
|
// Returns base64 encoded string of plaintext data
|
||||||
|
```
|
||||||
|
|
||||||
|
### Prompt user to save a file to disk
|
||||||
|
Note: mimeType not required but recommended. If not specified, saving will fail if the mimeType is unable to be derived from the Blob.
|
||||||
|
```
|
||||||
|
let res = await qortalRequest({
|
||||||
|
action: "SAVE_FILE",
|
||||||
|
blob: dataBlob,
|
||||||
|
filename: "myfile.pdf",
|
||||||
|
mimeType: "application/pdf" // Optional but recommended
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Get wallet balance (QORT)
|
### Get wallet balance (QORT)
|
||||||
_Requires user approval_
|
_Requires user approval_
|
||||||
```
|
```
|
||||||
await qortalRequest({
|
let res = await qortalRequest({
|
||||||
action: "GET_WALLET_BALANCE",
|
action: "GET_WALLET_BALANCE",
|
||||||
coin: "QORT"
|
coin: "QORT"
|
||||||
});
|
});
|
||||||
@ -508,7 +553,7 @@ let res = await qortalRequest({
|
|||||||
### Send QORT to address
|
### Send QORT to address
|
||||||
_Requires user approval_
|
_Requires user approval_
|
||||||
```
|
```
|
||||||
await qortalRequest({
|
let res = await qortalRequest({
|
||||||
action: "SEND_COIN",
|
action: "SEND_COIN",
|
||||||
coin: "QORT",
|
coin: "QORT",
|
||||||
destinationAddress: "QZLJV7wbaFyxaoZQsjm6rb9MWMiDzWsqM2",
|
destinationAddress: "QZLJV7wbaFyxaoZQsjm6rb9MWMiDzWsqM2",
|
||||||
@ -519,7 +564,7 @@ await qortalRequest({
|
|||||||
### Send foreign coin to address
|
### Send foreign coin to address
|
||||||
_Requires user approval_
|
_Requires user approval_
|
||||||
```
|
```
|
||||||
await qortalRequest({
|
let res = await qortalRequest({
|
||||||
action: "SEND_COIN",
|
action: "SEND_COIN",
|
||||||
coin: "LTC",
|
coin: "LTC",
|
||||||
destinationAddress: "LSdTvMHRm8sScqwCi6x9wzYQae8JeZhx6y",
|
destinationAddress: "LSdTvMHRm8sScqwCi6x9wzYQae8JeZhx6y",
|
||||||
@ -549,7 +594,7 @@ let res = await qortalRequest({
|
|||||||
### Send a group chat message
|
### Send a group chat message
|
||||||
_Requires user approval_
|
_Requires user approval_
|
||||||
```
|
```
|
||||||
await qortalRequest({
|
let res = await qortalRequest({
|
||||||
action: "SEND_CHAT_MESSAGE",
|
action: "SEND_CHAT_MESSAGE",
|
||||||
groupId: 0,
|
groupId: 0,
|
||||||
message: "Test"
|
message: "Test"
|
||||||
@ -559,7 +604,7 @@ await qortalRequest({
|
|||||||
### Send a private chat message
|
### Send a private chat message
|
||||||
_Requires user approval_
|
_Requires user approval_
|
||||||
```
|
```
|
||||||
await qortalRequest({
|
let res = await qortalRequest({
|
||||||
action: "SEND_CHAT_MESSAGE",
|
action: "SEND_CHAT_MESSAGE",
|
||||||
destinationAddress: "QZLJV7wbaFyxaoZQsjm6rb9MWMiDzWsqM2",
|
destinationAddress: "QZLJV7wbaFyxaoZQsjm6rb9MWMiDzWsqM2",
|
||||||
message: "Test"
|
message: "Test"
|
||||||
@ -579,7 +624,7 @@ let res = await qortalRequest({
|
|||||||
### Join a group
|
### Join a group
|
||||||
_Requires user approval_
|
_Requires user approval_
|
||||||
```
|
```
|
||||||
await qortalRequest({
|
let res = await qortalRequest({
|
||||||
action: "JOIN_GROUP",
|
action: "JOIN_GROUP",
|
||||||
groupId: 100
|
groupId: 100
|
||||||
});
|
});
|
||||||
|
Loading…
x
Reference in New Issue
Block a user