Add ability to set_attr channel/group custom_fields #40
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abrom
requested changes
Nov 9, 2022
lib/rocket_chat/messages/channel.rb
Outdated
| @@ -68,7 +68,7 @@ def online(room_id: nil, name: nil) | |||
| # * [String] topic A room's topic | |||
| # * [Strong] type c (channel) or p (private group) | |||
| def self.settable_attributes | |||
| %i[description join_code purpose read_only topic type] | |||
| %i[custom_fields description join_code purpose read_only topic type] | |||
There was a problem hiding this comment.
It would also be nice to see the other "new" setter attributes included. ie
Suggested change
| %i[custom_fields description join_code purpose read_only topic type] | |
| %i[announcement custom_fields default description join_code purpose read_only topic type] |
There was a problem hiding this comment.
And could you please also update the documentation in the comment above? likely:
* [String] announcement Announcement for the channel
* [Hash] custom_fields Custom fields for the channel
* [Boolean] default Sets whether the channel is a default channel or not
lib/rocket_chat/messages/group.rb
Outdated
| @@ -98,7 +98,7 @@ def online(room_id: nil, name: nil) | |||
| # * [String] topic A room's topic | |||
| # * [Strong] type c (channel) or p (private group) | |||
| def self.settable_attributes | |||
| %i[description purpose read_only topic type] | |||
| %i[custom_fields description purpose read_only topic type] | |||
There was a problem hiding this comment.
Same as above, although groups only have the custom_fields and announcement setters (no setDefault)
Suggested change
| %i[custom_fields description purpose read_only topic type] | |
| %i[announcement custom_fields description purpose read_only topic type] |
(and a similar comment change too! 😄 )
Aligning with create API and available endpoints
The extraData param allows setting arbitrary attributes on the RC Room. Added to the API in RC v3.12.0 by Rocket.Chat PR 20617, commit 2ad2d0bd7ed
reist
force-pushed
the
add-custom-fields-to-rooms-api
branch
from
6b78cbc
to
519484b
Compare
|
As I'm adding the rest of the |
abrom
reviewed
Nov 11, 2022
| @@ -309,7 +309,7 @@ def members(room_id: nil, name: nil, offset: nil, count: nil, sort: nil) | |||
| attr_reader :session | |||
|
|
|||
| def room_option_hash(options) | |||
| args = [options, :members, :read_only, :custom_fields] | |||
| args = [options, :members, :read_only, :custom_fields, :extra_data] | |||
There was a problem hiding this comment.
Change looks good, but could you update the documentation too? See docs/channels.md#L17
There was a problem hiding this comment.
Actually, don't worry.. I'll update it when I bump the release 😉
abrom
approved these changes
Nov 11, 2022
|
Released in v0.1.23 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Aligning with create API and available endpoints