Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Testing to see if dom-update-forums can be previewed post-PR because preview beforehand is not working #2937

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Testing to see if dom-update-forums can be previewed post-PR because preview beforehand is not working #2937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
245 changes: 227 additions & 18 deletions wix-forum-v2/wix-forum-v2/Categories.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,145 @@
" } catch (error) {",
" console.error(error);",
" // Handle the error",
" }",
{
"name": "subscribeContactToCategory",
"params": [
{
"name": "categoryId",
"type": [
{
"nativeType": "string"
}
],
"doc": "Category ID.",
"required": true
},
{
"name": "options",
"type": [
{
"referenceType": "wix-forum-v2.Categories.SubscribeContactToCategoryOptions"
}
],
"doc": "Options for subscribing the contact.",
"required": false
}
],
"requiredFields": [
"categoryId"
],
"ret": {
"type": [
{
"complexType": {
"nativeType": "Promise",
"typeParams": [
{
"nativeType": "void"
}
]
}
}
],
"doc": null
},
"docs": {
"summary": "Subscribes a contact to a specific forum category.",
"description": [
"By default a contact isn't subscribed to any forum categories.\n\nBy subscribing a contact to a category, the contact receives notifications for that category.\n\nIf `contactId` is not provided, it is implicitly resolved from the caller's context."
],
"examples": [
{
"title": "subscribeContactToCategory example",
"body": [
"import { categories } from '@wix/wix-forum.v2';",
" ",
" async function subscribeContactToCategory(categoryId, options) {",
" try {",
" const result = await categories.subscribeContactToCategory(categoryId, options);",
"",
" return result;",
" } catch (error) {",
" console.error(error);",
" // Handle the error",
" }",
" }",
" "
]
}
]
},
"isVeloEvent": false,
"customLabels": [
{
"id": "maturity-beta"
}
],
"syntaxName": "subscribeContactToCategory",
"isAdminMethod": true
},
{
"name": "unsubscribeContactFromCategory",
"params": [
{
"name": "categoryId",
"type": [
{
"nativeType": "string"
}
],
"doc": "Category ID.",
"required": true
},
{
"name": "options",
"type": [
{
"referenceType": "wix-forum-v2.Categories.UnsubscribeContactFromCategoryOptions"
}
],
"doc": "Options for unsubscribing the contact.",
"required": false
}
],
"requiredFields": [
"categoryId"
],
"ret": {
"type": [
{
"complexType": {
"nativeType": "Promise",
"typeParams": [
{
"nativeType": "void"
}
]
}
}
],
"doc": null
},
"docs": {
"summary": "Unsubscribes a contact from a specific forum category.",
"description": [
"By default a contact isn't subscribed to any forum categories.\n\nBy unsubscribing a contact from a category, the contact won’t receive notifications for that category.\n\nIf `contactId` is not provided, it is implicitly resolved from the caller's context."
],
"examples": [
{
"title": "unsubscribeContactFromCategory example",
"body": [
"import { categories } from '@wix/wix-forum.v2';",
" ",
" async function unsubscribeContactFromCategory(categoryId, options) {",
" try {",
" const result = await categories.unsubscribeContactFromCategory(categoryId, options);",
"",
" return result;",
" } catch (error) {",
" console.error(error);",
" // Handle the error",
" }",
" }",
" "
]
Expand All @@ -220,7 +358,9 @@
{
"id": "maturity-beta"
}
]
],
"syntaxName": "unsubscribeContactFromCategory",
"isAdminMethod": true
}
],
"messages": [
Expand Down Expand Up @@ -1190,50 +1330,119 @@
}
},
{
"name": "UpdateCategoryRequest",
"name": "SubscribeContactToCategoryOptions",
"members": [
{
"name": "category",
"name": "contactId",
"optional": true,
"type": [
{
"referenceType": "wix-forum-v2.Categories.Category"
"nativeType": "string"
}
],
"doc": "Editable category data."
"doc": "Contact ID."
}
],
"docs": {
"description": [
""
]
}
},
{
"name": "SubscribeContactToCategoryRequest",
"members": [
{
"name": "categoryId",
"type": [
{
"nativeType": "string"
}
],
"doc": "Category ID."
},
{
"name": "contactId",
"optional": true,
"type": [
{
"nativeType": "string"
}
],
"doc": "Contact ID."
}
],
"docs": {
"description": [
""
]
}
},
{
"name": "SubscribeContactToCategoryResponse",
"members": [],
"docs": {
"description": [
""
]
}
},
{
"name": "UnsubscribeContactFromCategoryOptions",
"members": [
{
"name": "contactId",
"optional": true,
"type": [
{
"nativeType": "string"
}
],
"doc": "Contact ID."
}
],
"docs": {
"description": [
""
]
}
{
"name": "UnsubscribeContactFromCategoryRequest",
"members": [
{
"name": "categoryId",
"type": [
{
"nativeType": "string"
}
],
"doc": "ID of category."
"doc": "Category ID."
},
{
"name": "fieldMask",
"name": "contactId",
"optional": true,
"type": [
{
"complexType": {
"nativeType": "Array",
"typeParams": [
{
"nativeType": "string"
}
]
}
"nativeType": "string"
}
],
"doc": "Field mask of fields to update."
"doc": "Contact ID."
}
],
"docs": {
"description": [
""
]
}
}
},
{
"name": "UnsubscribeContactFromCategoryResponse",
"members": [],
"docs": {
"description": [
""
]
}
},
]
}
76 changes: 76 additions & 0 deletions wix-forum-v2/wix-forum-v2/Events.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1719,6 +1719,82 @@
]
}
},
{
"name": "forumV1CategorySubscribeContactToCategoryRequest",
"members": [
{
"name": "categoryId",
"type": [
{
"nativeType": "string"
}
],
"doc": "Category ID."
},
{
"name": "contactId",
"optional": true,
"type": [
{
"nativeType": "string"
}
],
"doc": "Contact ID."
}
],
"docs": {
"description": [
""
]
}
},
{
"name": "forumV1CategorySubscribeContactToCategoryResponse",
"members": [],
"docs": {
"description": [
""
]
}
},
{
"name": "forumV1CategoryUnsubscribeContactFromCategoryRequest",
"members": [
{
"name": "categoryId",
"type": [
{
"nativeType": "string"
}
],
"doc": "Category ID."
},
{
"name": "contactId",
"optional": true,
"type": [
{
"nativeType": "string"
}
],
"doc": "Contact ID."
}
],
"docs": {
"description": [
""
]
}
},
{
"name": "forumV1CategoryUnsubscribeContactFromCategoryResponse",
"members": [],
"docs": {
"description": [
""
]
}
},
{
"name": "forumV1CategoryUpdateCategoryRequest",
"members": [
Expand Down