@docbrasil/api-systemmanager 1.1.12 → 1.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/doc/api.md CHANGED
@@ -1788,6 +1788,11 @@ Class for my tasks, permission user
1788
1788
  * [.find(params, session)](#MyTasks+find) ⇒ <code>promise</code> \| <code>number</code> \| <code>array.&lt;object&gt;</code> \| <code>number</code> \| <code>number</code>
1789
1789
  * [.saveDueDate(params, session)](#MyTasks+saveDueDate) ⇒ <code>Promise</code>
1790
1790
  * [.removeDueDate(session)](#MyTasks+removeDueDate) ⇒ <code>Promise</code>
1791
+ * [.getTaskMultiUsers(params, session)](#MyTasks+getTaskMultiUsers) ⇒ <code>promise</code>
1792
+ * [.removeMultiTaskUser(params, session)](#MyTasks+removeMultiTaskUser) ⇒ <code>Promise</code>
1793
+ * [.addMultiTaskUser(params, session)](#MyTasks+addMultiTaskUser) ⇒ <code>Promise</code>
1794
+ * [.getAssignTaskUsers(params, session)](#MyTasks+getAssignTaskUsers) ⇒ <code>promise</code>
1795
+ * [.assignTaskUsers(params, session)](#MyTasks+assignTaskUsers) ⇒ <code>Promise</code>
1791
1796
 
1792
1797
  <a name="MyTasks+find"></a>
1793
1798
 
@@ -1850,6 +1855,109 @@ Update task dueDate
1850
1855
  ```js
1851
1856
  const API = require('@docbrasil/api-systemmanager');
1852
1857
  orgId: '646386c9583e04a131adc894',
1853
1858
  taskId: '646386c9583e04a131adc895'
1854
1859
  ```
1860
+ <a name="MyTasks+getTaskMultiUsers"></a>
1861
+
1862
+ ### myTasks.getTaskMultiUsers(params, session) ⇒ <code>promise</code>
1863
+ Method to get task multi users
1864
+
1865
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
1866
+ **Access**: public
1867
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
1868
+
1869
+ | Param | Type | Description |
1870
+ | --- | --- | --- |
1871
+ | params | <code>object</code> | Params to get task |
1872
+ | params.taskId | <code>object</code> | Task id (_id database) |
1873
+ | params.orgId | <code>object</code> | Organization id (_id database) |
1874
+ | session | <code>string</code> | Session, token JWT |
1875
+
1876
+ **Example**
1877
+ ```js
1878
+ const API = require('@docbrasil/api-systemmanager');
1855
1879
  taskId: '5df7f19618430c89a41a19d2',
1856
1880
  orgId: '55e4a3bd6be6b45210833fae',
1881
+ ```
1882
+ <a name="MyTasks+removeMultiTaskUser"></a>
1883
+
1884
+ ### myTasks.removeMultiTaskUser(params, session) ⇒ <code>Promise</code>
1885
+ remove multi task user
1886
+
1887
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
1888
+ **Access**: public
1889
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
1890
+
1891
+ | Param | Type | Description |
1892
+ | --- | --- | --- |
1893
+ | params | <code>object</code> | Params of the user to be removed |
1894
+ | params.userId | <code>string</code> | User id |
1895
+ | params.orgId | <code>string</code> | Organization id |
1896
+ | params.taskId | <code>string</code> | Task Id |
1897
+ | session | <code>string</code> | Is token JWT of user |
1898
+
1899
+ **Example**
1900
+ ```js
1901
+ const API = require('@docbrasil/api-systemmanager');
1857
1902
  userId: '646386c9583e04a131adc896',
1858
1903
  orgId: '646386c9583e04a131adc894',
1859
1904
  taskId: '646386c9583e04a131adc895'
1905
+ ```
1906
+ <a name="MyTasks+addMultiTaskUser"></a>
1907
+
1908
+ ### myTasks.addMultiTaskUser(params, session) ⇒ <code>Promise</code>
1909
+ Add Multi Task User
1910
+
1911
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
1912
+ **Access**: public
1913
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
1914
+
1915
+ | Param | Type | Description |
1916
+ | --- | --- | --- |
1917
+ | params | <code>object</code> | Params for adding multi task user |
1918
+ | params.userId | <code>string</code> | User id |
1919
+ | params.orgId | <code>string</code> | Organization id |
1920
+ | params.taskId | <code>string</code> | Task Id |
1921
+ | session | <code>string</code> | Is token JWT of user |
1922
+
1923
+ **Example**
1924
+ ```js
1925
+ const API = require('@docbrasil/api-systemmanager');
1860
1926
  userId: '646386c9583e04a131adc8946',
1861
1927
  orgId: '646386c9583e04a131adc894',
1862
1928
  taskId: '646386c9583e04a131adc895'
1929
+ ```
1930
+ <a name="MyTasks+getAssignTaskUsers"></a>
1931
+
1932
+ ### myTasks.getAssignTaskUsers(params, session) ⇒ <code>promise</code>
1933
+ Method to get assign task users
1934
+
1935
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
1936
+ **Access**: public
1937
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
1938
+
1939
+ | Param | Type | Description |
1940
+ | --- | --- | --- |
1941
+ | params | <code>object</code> | Params to get task |
1942
+ | params.taskId | <code>object</code> | Task id (_id database) |
1943
+ | params.orgId | <code>object</code> | Organization id (_id database) |
1944
+ | session | <code>string</code> | Session, token JWT |
1945
+
1946
+ **Example**
1947
+ ```js
1948
+ const API = require('@docbrasil/api-systemmanager');
1863
1949
  taskId: '5df7f19618430c89a41a19d2',
1864
1950
  orgId: '55e4a3bd6be6b45210833fae',
1951
+ ```
1952
+ <a name="MyTasks+assignTaskUsers"></a>
1953
+
1954
+ ### myTasks.assignTaskUsers(params, session) ⇒ <code>Promise</code>
1955
+ Assign Task user
1956
+
1957
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
1958
+ **Access**: public
1959
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
1960
+
1961
+ | Param | Type | Description |
1962
+ | --- | --- | --- |
1963
+ | params | <code>object</code> | The params to assign task to user |
1964
+ | params.orgName | <code>string</code> | Organization Name |
1965
+ | params.userId | <code>string</code> | User id that will be assigned the task |
1966
+ | params.taskId | <code>string</code> | Task Id |
1967
+ | session | <code>string</code> | Is token JWT of user |
1968
+
1969
+ **Example**
1970
+ ```js
1971
+ const API = require('@docbrasil/api-systemmanager');
1865
1972
  orgName: 'pinkbrain',
1866
1973
  userId: '646386c9583e04a131adc894',
1867
1974
  taskId: '646386c9583e04a131adc895'
1975
+ ```
1868
1976
  <a name="Notification"></a>
1869
1977
 
1870
1978
  ## Notification