You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+13
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,7 @@ The option <code>--provider</code> must be set in all commands. It should be set
25
25
### Commands:
26
26
#### create
27
27
Creates a new TIC account by generating a profile and a contacts channel and saving its channel roots on the tangle.
28
+
28
29
| Param | Type | Default | Description |
29
30
| --- | --- | --- | --- |
30
31
| seed | <code>string</code> || The seed of the TIC account to create. It's used to create the public master channel of the account where the channel roots of the profile and contacts channel are published. |
Reads the content of a TIC account from the tangle.
40
+
39
41
| Param | Type | Default | Description |
40
42
| --- | --- | --- | --- |
41
43
| seed | <code>string</code> || The seed of the TIC account |
42
44
| masterRoot | <code>string</code> || The root of the master channel of the TIC account to read |
43
45
| profileRoot | <code>string</code> || The channel root of the profile channel to read |
44
46
| contactsRoot | <code>string</code> || The channel root of the contacts channel to read |
45
47
| password | <code>string</code> | seed | The tryte-encoded password to get the seeds of profile and contacts channel in the restricted channel of the TIC account. If password is not given the seed is used as a default. If null is given the seeds aren't retrieved. |
48
+
46
49
One of these params is needed to read content from an account. The cli will look for them in descending order of the table. If profile and contacts root are given both channels are read.
47
50
The password is only needed together with the seed.
Adds the given information in JSON format to the profile of a TIC account.
59
+
56
60
| Param | Type | Default | Description |
57
61
| --- | --- | --- | --- |
58
62
| seed | <code>string</code> || The seed of the TIC account |
59
63
| password | <code>string</code> | seed | The tryte-encoded password of the TIC account. It's used to retrieve the channel root from the restricted channel. If password is not given the seed is used as a default. If null is given the seed can't be retrieved. |
60
64
| profileSeed | <code>string</code> || The channel root of the profile channel to add information to |
61
65
| content | <code>string</code> || The information to add to the profile in form of key/value pairs formatted as a JSON object. '"' might be needed to escape and the content must be wraped in '' |
66
+
62
67
Only seed or profile seed is needed for this request. Seed can only be used if channel seeds are saved on the tangle with the
Removes the properties as a JSON array from the profile of a TIC account.
78
+
73
79
| Param | Type | Default | Description |
74
80
| --- | --- | --- | --- |
75
81
| seed | <code>string</code> || The seed of the TIC account |
76
82
| password | <code>string</code> | seed | The tryte-encoded password of the TIC account. It's used to retrieve the channel root from the restricted channel. If password is not given the seed is used as a default. If null is given the seed can't be retrieved. |
77
83
| profileSeed | <code>string</code> || The channel root of the profile channel to remove information from |
78
84
| content | <code>string</code> || The information to remove from the profile in form of the keys formatted as a JSON array. '"' might be needed to escape and the content must be wraped in '' |
85
+
79
86
Only seed or profile seed is needed for this request. Seed can only be used if channel seeds are saved on the tangle with the
80
87
given password.
81
88
Please note that the information is not really deleted from the tangle as that is not possible. The given information could be read on the mam channel as before by everyone. This request has the effect that the TIC library will not consider the given properties in information that has been published to this profile before, when compiling the profile information.
Adds the given account to the trusted contacts of a TIC account.
97
+
90
98
| Param | Type | Default | Description |
91
99
| --- | --- | --- | --- |
92
100
| seed | <code>string</code> || The seed of the TIC account |
93
101
| password | <code>string</code> | seed | The tryte-encoded password of the TIC account. It's used to retrieve the channel root from the restricted channel. If password is not given the seed is used as a default. If null is given the seed can't be retrieved. |
94
102
| contactsSeed | <code>string</code> || The channel root of the contacts channel to add trusts to |
95
103
| content | <code>string</code> || The master channel roots of the accounts to add to the trusted contacts formatted as a JSON array. '"' might be needed to escape and the content must be wraped in '' |
104
+
96
105
Only seed or contacts seed is needed for this request. Seed can only be used if channel seeds are saved on the tangle with the
Adds the given account to the distrusted contacts of a TIC account.
116
+
107
117
| Param | Type | Default | Description |
108
118
| --- | --- | --- | --- |
109
119
| seed | <code>string</code> || The seed of the TIC account |
110
120
| password | <code>string</code> | seed | The tryte-encoded password of the TIC account. It's used to retrieve the channel root from the restricted channel. If password is not given the seed is used as a default. If null is given the seed can't be retrieved. |
111
121
| contactsSeed | <code>string</code> || The channel root of the contacts channel to add distrusts to |
112
122
| content | <code>string</code> || The master channel roots of the accounts to add to the distrusted contacts formatted as a JSON array. '"' might be needed to escape and the content must be wraped in '' |
123
+
113
124
Only seed or contacts seed is needed for this request. Seed can only be used if channel seeds are saved on the tangle with the
Copy file name to clipboardexpand all lines: jsdoc2md/README.hbs
+13
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,7 @@ The option <code>--provider</code> must be set in all commands. It should be set
25
25
### Commands:
26
26
#### create
27
27
Creates a new TIC account by generating a profile and a contacts channel and saving its channel roots on the tangle.
28
+
28
29
| Param | Type | Default | Description |
29
30
| --- | --- | --- | --- |
30
31
| seed | <code>string</code> | | The seed of the TIC account to create. It's used to create the public master channel of the account where the channel roots of the profile and contacts channel are published. |
Reads the content of a TIC account from the tangle.
40
+
39
41
| Param | Type | Default | Description |
40
42
| --- | --- | --- | --- |
41
43
| seed | <code>string</code> | | The seed of the TIC account |
42
44
| masterRoot | <code>string</code> | | The root of the master channel of the TIC account to read |
43
45
| profileRoot | <code>string</code> | | The channel root of the profile channel to read |
44
46
| contactsRoot | <code>string</code> | | The channel root of the contacts channel to read |
45
47
| password | <code>string</code> | seed | The tryte-encoded password to get the seeds of profile and contacts channel in the restricted channel of the TIC account. If password is not given the seed is used as a default. If null is given the seeds aren't retrieved. |
48
+
46
49
One of these params is needed to read content from an account. The cli will look for them in descending order of the table. If profile and contacts root are given both channels are read.
47
50
The password is only needed together with the seed.
Adds the given information in JSON format to the profile of a TIC account.
59
+
56
60
| Param | Type | Default | Description |
57
61
| --- | --- | --- | --- |
58
62
| seed | <code>string</code> | | The seed of the TIC account |
59
63
| password | <code>string</code> | seed | The tryte-encoded password of the TIC account. It's used to retrieve the channel root from the restricted channel. If password is not given the seed is used as a default. If null is given the seed can't be retrieved. |
60
64
| profileSeed | <code>string</code> | | The channel root of the profile channel to add information to |
61
65
| content | <code>string</code> | | The information to add to the profile in form of key/value pairs formatted as a JSON object. '"' might be needed to escape and the content must be wraped in '' |
66
+
62
67
Only seed or profile seed is needed for this request. Seed can only be used if channel seeds are saved on the tangle with the
Removes the properties as a JSON array from the profile of a TIC account.
78
+
73
79
| Param | Type | Default | Description |
74
80
| --- | --- | --- | --- |
75
81
| seed | <code>string</code> | | The seed of the TIC account |
76
82
| password | <code>string</code> | seed | The tryte-encoded password of the TIC account. It's used to retrieve the channel root from the restricted channel. If password is not given the seed is used as a default. If null is given the seed can't be retrieved. |
77
83
| profileSeed | <code>string</code> | | The channel root of the profile channel to remove information from |
78
84
| content | <code>string</code> | | The information to remove from the profile in form of the keys formatted as a JSON array. '"' might be needed to escape and the content must be wraped in '' |
85
+
79
86
Only seed or profile seed is needed for this request. Seed can only be used if channel seeds are saved on the tangle with the
80
87
given password.
81
88
Please note that the information is not really deleted from the tangle as that is not possible. The given information could be read on the mam channel as before by everyone. This request has the effect that the TIC library will not consider the given properties in information that has been published to this profile before, when compiling the profile information.
Adds the given account to the trusted contacts of a TIC account.
97
+
90
98
| Param | Type | Default | Description |
91
99
| --- | --- | --- | --- |
92
100
| seed | <code>string</code> | | The seed of the TIC account |
93
101
| password | <code>string</code> | seed | The tryte-encoded password of the TIC account. It's used to retrieve the channel root from the restricted channel. If password is not given the seed is used as a default. If null is given the seed can't be retrieved. |
94
102
| contactsSeed | <code>string</code> | | The channel root of the contacts channel to add trusts to |
95
103
| content | <code>string</code> | | The master channel roots of the accounts to add to the trusted contacts formatted as a JSON array. '"' might be needed to escape and the content must be wraped in '' |
104
+
96
105
Only seed or contacts seed is needed for this request. Seed can only be used if channel seeds are saved on the tangle with the
Adds the given account to the distrusted contacts of a TIC account.
116
+
107
117
| Param | Type | Default | Description |
108
118
| --- | --- | --- | --- |
109
119
| seed | <code>string</code> | | The seed of the TIC account |
110
120
| password | <code>string</code> | seed | The tryte-encoded password of the TIC account. It's used to retrieve the channel root from the restricted channel. If password is not given the seed is used as a default. If null is given the seed can't be retrieved. |
111
121
| contactsSeed | <code>string</code> | | The channel root of the contacts channel to add distrusts to |
112
122
| content | <code>string</code> | | The master channel roots of the accounts to add to the distrusted contacts formatted as a JSON array. '"' might be needed to escape and the content must be wraped in '' |
123
+
113
124
Only seed or contacts seed is needed for this request. Seed can only be used if channel seeds are saved on the tangle with the
0 commit comments