Skip to content

Commit 4048a18

Browse files
liuliquanliuliquan
committed
docs
1 parent 15d41e6 commit 4048a18

12 files changed

+947
-11
lines changed

‎docs/actions.lookup.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<a name="module_actions.lookup"></a>
2+
3+
## actions.lookup
4+
Actions related to lookup data.
5+
6+
<a name="module_actions.lookup.getApprovedSkills"></a>
7+
8+
### actions.lookup.getApprovedSkills() ⇒ <code>Action</code>
9+
Gets approved skill tags.
10+
11+
**Kind**: static method of [<code>actions.lookup</code>](#module_actions.lookup)

‎docs/actions.profile.md

Lines changed: 308 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,35 @@ Actions for interactions with profile details API.
2323
* [.getSkillsDone(handle)](#module_actions.profile.getSkillsDone) ⇒ <code>Action</code>
2424
* [.getStatsInit()](#module_actions.profile.getStatsInit) ⇒ <code>Action</code>
2525
* [.getStatsDone(handle)](#module_actions.profile.getStatsDone) ⇒ <code>Action</code>
26+
* [.getActiveChallengesCountInit()](#module_actions.profile.getActiveChallengesCountInit) ⇒ <code>Action</code>
27+
* [.getActiveChallengesCountDone(handle, tokenV3)](#module_actions.profile.getActiveChallengesCountDone) ⇒ <code>Action</code>
28+
* [.getLinkedAccountsInit()](#module_actions.profile.getLinkedAccountsInit) ⇒ <code>Action</code>
29+
* [.getLinkedAccountsDone(profile, tokenV3)](#module_actions.profile.getLinkedAccountsDone) ⇒ <code>Action</code>
30+
* [.getCredentialInit()](#module_actions.profile.getCredentialInit) ⇒ <code>Action</code>
31+
* [.getCredentialDone(profile, tokenV3)](#module_actions.profile.getCredentialDone) ⇒ <code>Action</code>
32+
* [.getEmailPreferencesInit()](#module_actions.profile.getEmailPreferencesInit) ⇒ <code>Action</code>
33+
* [.getEmailPreferencesDone(profile, tokenV3)](#module_actions.profile.getEmailPreferencesDone) ⇒ <code>Action</code>
34+
* [.uploadPhotoInit()](#module_actions.profile.uploadPhotoInit) ⇒ <code>Action</code>
35+
* [.uploadPhotoDone(handle, tokenV3, file)](#module_actions.profile.uploadPhotoDone) ⇒ <code>Action</code>
36+
* [.deletePhotoInit()](#module_actions.profile.deletePhotoInit) ⇒ <code>Action</code>
37+
* [.updateProfileInit()](#module_actions.profile.updateProfileInit) ⇒ <code>Action</code>
38+
* [.updateProfileDone(profile, tokenV3)](#module_actions.profile.updateProfileDone) ⇒ <code>Action</code>
39+
* [.addSkillInit()](#module_actions.profile.addSkillInit) ⇒ <code>Action</code>
40+
* [.addSkillDone(handle, tokenV3, skill)](#module_actions.profile.addSkillDone) ⇒ <code>Action</code>
41+
* [.hideSkillInit()](#module_actions.profile.hideSkillInit) ⇒ <code>Action</code>
42+
* [.hideSkillDone(handle, tokenV3, skill)](#module_actions.profile.hideSkillDone) ⇒ <code>Action</code>
43+
* [.addWebLinkInit()](#module_actions.profile.addWebLinkInit) ⇒ <code>Action</code>
44+
* [.addWebLinkDone(handle, tokenV3, webLink)](#module_actions.profile.addWebLinkDone) ⇒ <code>Action</code>
45+
* [.deleteWebLinkInit(key)](#module_actions.profile.deleteWebLinkInit) ⇒ <code>Action</code>
46+
* [.deleteWebLinkDone(handle, tokenV3, webLink)](#module_actions.profile.deleteWebLinkDone) ⇒ <code>Action</code>
47+
* [.linkExternalAccountInit()](#module_actions.profile.linkExternalAccountInit) ⇒ <code>Action</code>
48+
* [.linkExternalAccountDone(profile, tokenV3, providerType, callbackUrl)](#module_actions.profile.linkExternalAccountDone) ⇒ <code>Action</code>
49+
* [.unlinkExternalAccountInit(providerType)](#module_actions.profile.unlinkExternalAccountInit) ⇒ <code>Action</code>
50+
* [.unlinkExternalAccountDone(profile, tokenV3, providerType)](#module_actions.profile.unlinkExternalAccountDone) ⇒ <code>Action</code>
51+
* [.saveEmailPreferencesInit()](#module_actions.profile.saveEmailPreferencesInit) ⇒ <code>Action</code>
52+
* [.saveEmailPreferencesDone(profile, tokenV3, preferences)](#module_actions.profile.saveEmailPreferencesDone) ⇒ <code>Action</code>
53+
* [.updatePasswordInit()](#module_actions.profile.updatePasswordInit) ⇒ <code>Action</code>
54+
* [.updatePasswordDone(profile, tokenV3, newPassword, oldPassword)](#module_actions.profile.updatePasswordDone) ⇒ <code>Action</code>
2655

2756
<a name="module_actions.profile.loadProfile"></a>
2857

@@ -167,3 +196,282 @@ Creates an action that loads member's stats.
167196
| --- | --- | --- |
168197
| handle | <code>String</code> | Member handle. |
169198

199+
<a name="module_actions.profile.getActiveChallengesCountInit"></a>
200+
201+
### actions.profile.getActiveChallengesCountInit() ⇒ <code>Action</code>
202+
Creates an action that signals beginning of getting count of user's active challenges.
203+
204+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
205+
<a name="module_actions.profile.getActiveChallengesCountDone"></a>
206+
207+
### actions.profile.getActiveChallengesCountDone(handle, tokenV3) ⇒ <code>Action</code>
208+
Creates an action that gets count of user's active challenges from the backend.
209+
210+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
211+
212+
| Param | Type | Description |
213+
| --- | --- | --- |
214+
| handle | <code>String</code> | Topcoder user handle. |
215+
| tokenV3 | <code>String</code> | Optional. Topcoder auth token v3. Without token only public challenges will be counted. With the token provided, the action will also count private challenges related to this user. |
216+
217+
<a name="module_actions.profile.getLinkedAccountsInit"></a>
218+
219+
### actions.profile.getLinkedAccountsInit() ⇒ <code>Action</code>
220+
Creates an action that signals beginning of getting linked accounts.
221+
222+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
223+
<a name="module_actions.profile.getLinkedAccountsDone"></a>
224+
225+
### actions.profile.getLinkedAccountsDone(profile, tokenV3) ⇒ <code>Action</code>
226+
Creates an action that gets linked accounts.
227+
228+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
229+
230+
| Param | Type | Description |
231+
| --- | --- | --- |
232+
| profile | <code>Object</code> | Topcoder member profile. |
233+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
234+
235+
<a name="module_actions.profile.getCredentialInit"></a>
236+
237+
### actions.profile.getCredentialInit() ⇒ <code>Action</code>
238+
Creates an action that signals beginning of getting credential.
239+
240+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
241+
<a name="module_actions.profile.getCredentialDone"></a>
242+
243+
### actions.profile.getCredentialDone(profile, tokenV3) ⇒ <code>Action</code>
244+
Creates an action that gets credential.
245+
246+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
247+
248+
| Param | Type | Description |
249+
| --- | --- | --- |
250+
| profile | <code>Object</code> | Topcoder member profile. |
251+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
252+
253+
<a name="module_actions.profile.getEmailPreferencesInit"></a>
254+
255+
### actions.profile.getEmailPreferencesInit() ⇒ <code>Action</code>
256+
Creates an action that signals beginning of getting email preferences.
257+
258+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
259+
<a name="module_actions.profile.getEmailPreferencesDone"></a>
260+
261+
### actions.profile.getEmailPreferencesDone(profile, tokenV3) ⇒ <code>Action</code>
262+
Creates an action that gets email preferences.
263+
264+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
265+
266+
| Param | Type | Description |
267+
| --- | --- | --- |
268+
| profile | <code>Object</code> | Topcoder member profile. |
269+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
270+
271+
<a name="module_actions.profile.uploadPhotoInit"></a>
272+
273+
### actions.profile.uploadPhotoInit() ⇒ <code>Action</code>
274+
Creates an action that signals beginning of uploading user's photo.
275+
276+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
277+
<a name="module_actions.profile.uploadPhotoDone"></a>
278+
279+
### actions.profile.uploadPhotoDone(handle, tokenV3, file) ⇒ <code>Action</code>
280+
Creates an action that uploads user's photo.
281+
282+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
283+
284+
| Param | Type | Description |
285+
| --- | --- | --- |
286+
| handle | <code>String</code> | Topcoder user handle. |
287+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
288+
| file | <code>String</code> | The photo file. |
289+
290+
<a name="module_actions.profile.deletePhotoInit"></a>
291+
292+
### actions.profile.deletePhotoInit() ⇒ <code>Action</code>
293+
Creates an action that signals beginning of deleting user's photo.
294+
295+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
296+
<a name="module_actions.profile.updateProfileInit"></a>
297+
298+
### actions.profile.updateProfileInit() ⇒ <code>Action</code>
299+
Creates an action that signals beginning of updating user's profile.
300+
301+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
302+
<a name="module_actions.profile.updateProfileDone"></a>
303+
304+
### actions.profile.updateProfileDone(profile, tokenV3) ⇒ <code>Action</code>
305+
Creates an action that updates user's profile.
306+
307+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
308+
309+
| Param | Type | Description |
310+
| --- | --- | --- |
311+
| profile | <code>String</code> | Topcoder user profile. |
312+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
313+
314+
<a name="module_actions.profile.addSkillInit"></a>
315+
316+
### actions.profile.addSkillInit() ⇒ <code>Action</code>
317+
Creates an action that signals beginning of adding user's skill.
318+
319+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
320+
<a name="module_actions.profile.addSkillDone"></a>
321+
322+
### actions.profile.addSkillDone(handle, tokenV3, skill) ⇒ <code>Action</code>
323+
Creates an action that adds user's skill.
324+
325+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
326+
327+
| Param | Type | Description |
328+
| --- | --- | --- |
329+
| handle | <code>String</code> | Topcoder user handle. |
330+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
331+
| skill | <code>Object</code> | Skill to add. |
332+
333+
<a name="module_actions.profile.hideSkillInit"></a>
334+
335+
### actions.profile.hideSkillInit() ⇒ <code>Action</code>
336+
Creates an action that signals beginning of hiding user's skill.
337+
338+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
339+
<a name="module_actions.profile.hideSkillDone"></a>
340+
341+
### actions.profile.hideSkillDone(handle, tokenV3, skill) ⇒ <code>Action</code>
342+
Creates an action that hides user's skill.
343+
344+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
345+
346+
| Param | Type | Description |
347+
| --- | --- | --- |
348+
| handle | <code>String</code> | Topcoder user handle. |
349+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
350+
| skill | <code>Object</code> | Skill to hide. |
351+
352+
<a name="module_actions.profile.addWebLinkInit"></a>
353+
354+
### actions.profile.addWebLinkInit() ⇒ <code>Action</code>
355+
Creates an action that signals beginning of adding user's web link.
356+
357+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
358+
<a name="module_actions.profile.addWebLinkDone"></a>
359+
360+
### actions.profile.addWebLinkDone(handle, tokenV3, webLink) ⇒ <code>Action</code>
361+
Creates an action that adds user's web link.
362+
363+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
364+
365+
| Param | Type | Description |
366+
| --- | --- | --- |
367+
| handle | <code>String</code> | Topcoder user handle. |
368+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
369+
| webLink | <code>String</code> | Web link to add. |
370+
371+
<a name="module_actions.profile.deleteWebLinkInit"></a>
372+
373+
### actions.profile.deleteWebLinkInit(key) ⇒ <code>Action</code>
374+
Creates an action that signals beginning of deleting user's web link.
375+
376+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
377+
378+
| Param | Type | Description |
379+
| --- | --- | --- |
380+
| key | <code>Object</code> | Web link key to delete. |
381+
382+
<a name="module_actions.profile.deleteWebLinkDone"></a>
383+
384+
### actions.profile.deleteWebLinkDone(handle, tokenV3, webLink) ⇒ <code>Action</code>
385+
Creates an action that deletes user's web link.
386+
387+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
388+
389+
| Param | Type | Description |
390+
| --- | --- | --- |
391+
| handle | <code>String</code> | Topcoder user handle. |
392+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
393+
| webLink | <code>String</code> | Web link to delete. |
394+
395+
<a name="module_actions.profile.linkExternalAccountInit"></a>
396+
397+
### actions.profile.linkExternalAccountInit() ⇒ <code>Action</code>
398+
Creates an action that signals beginning of linking external account.
399+
400+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
401+
<a name="module_actions.profile.linkExternalAccountDone"></a>
402+
403+
### actions.profile.linkExternalAccountDone(profile, tokenV3, providerType, callbackUrl) ⇒ <code>Action</code>
404+
Creates an action that links external account.
405+
406+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
407+
408+
| Param | Type | Description |
409+
| --- | --- | --- |
410+
| profile | <code>Object</code> | Topcoder member handle. |
411+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
412+
| providerType | <code>String</code> | The external account service provider |
413+
| callbackUrl | <code>String</code> | Optional. The callback url |
414+
415+
<a name="module_actions.profile.unlinkExternalAccountInit"></a>
416+
417+
### actions.profile.unlinkExternalAccountInit(providerType) ⇒ <code>Action</code>
418+
Creates an action that signals beginning of unlinking external account.
419+
420+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
421+
422+
| Param | Type | Description |
423+
| --- | --- | --- |
424+
| providerType | <code>Object</code> | External account provider type to delete. |
425+
426+
<a name="module_actions.profile.unlinkExternalAccountDone"></a>
427+
428+
### actions.profile.unlinkExternalAccountDone(profile, tokenV3, providerType) ⇒ <code>Action</code>
429+
Creates an action that unlinks external account.
430+
431+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
432+
433+
| Param | Type | Description |
434+
| --- | --- | --- |
435+
| profile | <code>Object</code> | Topcoder member profile. |
436+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
437+
| providerType | <code>String</code> | The external account service provider |
438+
439+
<a name="module_actions.profile.saveEmailPreferencesInit"></a>
440+
441+
### actions.profile.saveEmailPreferencesInit() ⇒ <code>Action</code>
442+
Creates an action that signals beginning of saving email preferences.
443+
444+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
445+
<a name="module_actions.profile.saveEmailPreferencesDone"></a>
446+
447+
### actions.profile.saveEmailPreferencesDone(profile, tokenV3, preferences) ⇒ <code>Action</code>
448+
Creates an action that saves email preferences.
449+
450+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
451+
452+
| Param | Type | Description |
453+
| --- | --- | --- |
454+
| profile | <code>Object</code> | Topcoder member profile. |
455+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
456+
| preferences | <code>Object</code> | The email preferences |
457+
458+
<a name="module_actions.profile.updatePasswordInit"></a>
459+
460+
### actions.profile.updatePasswordInit() ⇒ <code>Action</code>
461+
Creates an action that signals beginning of updating user password.
462+
463+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
464+
<a name="module_actions.profile.updatePasswordDone"></a>
465+
466+
### actions.profile.updatePasswordDone(profile, tokenV3, newPassword, oldPassword) ⇒ <code>Action</code>
467+
Creates an action that updates user password.
468+
469+
**Kind**: static method of [<code>actions.profile</code>](#module_actions.profile)
470+
471+
| Param | Type | Description |
472+
| --- | --- | --- |
473+
| profile | <code>Object</code> | Topcoder member profile. |
474+
| tokenV3 | <code>String</code> | Topcoder auth token v3. |
475+
| newPassword | <code>String</code> | The new password |
476+
| oldPassword | <code>String</code> | The old password |
477+

‎docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ messaging.</p>
2525
<dd><p>Actions related to user groups.</p>
2626
</dd>
2727
<dt>
28+
<a href="actions.lookup.md">actions.lookup</a></dt>
29+
<dd><p>Actions related to lookup data.</p>
30+
</dd>
31+
<dt>
2832
<a href="actions.member-tasks.md">actions.member-tasks</a></dt>
2933
<dd><p>Actions for management of member tasks and payments. Under the hood it
3034
is very similar to the challenge listing management, as these tasks are in
@@ -94,6 +98,11 @@ not look really necessary at the moment, thus we do not provide an
9498
action to really cancel group loading.</p>
9599
</dd>
96100
<dt>
101+
<a href="reducers.lookup.md">reducers.lookup</a></dt>
102+
<dd><p>Reducer for <a href="#module_actions.lookup">actions.lookup</a> actions.</p>
103+
<p>State segment managed by this reducer has the following structure:</p>
104+
</dd>
105+
<dt>
97106
<a href="reduces.member-tasks.md">reduces.member-tasks</a></dt>
98107
<dd><p>Member tasks reducer.</p>
99108
</dd>
@@ -162,6 +171,11 @@ Also each group in the group map is timestamped to keep caching of
162171
the loaded data.</p>
163172
</dd>
164173
<dt>
174+
<a href="services.lookup.md">services.lookup</a></dt>
175+
<dd><p>This module provides a service to get lookup data from Topcoder
176+
via API V3.</p>
177+
</dd>
178+
<dt>
165179
<a href="services.members.md">services.members</a></dt>
166180
<dd><p>This module provides a service for searching for Topcoder
167181
members via API V3.</p>

0 commit comments

Comments
 (0)