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.

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

Makes an ARTChannelProperties initialiser public #1992

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

umair-ably
Copy link
Contributor

@umair-ably umair-ably commented Oct 13, 2024

Makes an ARTChannelProperties initialiser public to allow for attachSerial and channelSerial to be set and tested in other SDKs e.g. chat-swift

Summary by CodeRabbit

  • New Features
    • Introduced a new initialization method for channel properties to enhance channel management.
  • Bug Fixes
    • Removed outdated interface and method to streamline functionality and improve performance.

@umair-ably umair-ably requested a review from maratal October 13, 2024 18:49
Copy link

coderabbitai bot commented Oct 13, 2024

Walkthrough

The changes involve the removal of the ARTChannelProperties interface and a specific initializer method from the ARTRealtimeChannel+Private.h file. In contrast, the same initializer method is added to the ARTRealtimeChannel.h file, indicating a restructuring of the ARTChannelProperties class interface.

Changes

File Path Change Summary
Source/PrivateHeaders/Ably/ARTRealtimeChannel+Private.h - Removed interface: ARTChannelProperties
- Removed method: - (instancetype)initWithAttachSerial:channelSerial:
Source/include/Ably/ARTRealtimeChannel.h - Added method: - (instancetype)initWithAttachSerial:(nullable NSString *)attachSerial channelSerial:(nullable NSString *)channelSerial in class ARTChannelProperties

Possibly related PRs

Suggested reviewers

  • lawrence-forooghian

Poem

🐇 In the code where channels play,
A method lost, then found its way.
From private realms, it took its flight,
To public skies, shining bright.
With changes made, we hop along,
In the world of code, we all belong! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3c563f6 and 1c0cc55.

📒 Files selected for processing (2)
  • Source/PrivateHeaders/Ably/ARTRealtimeChannel+Private.h (0 hunks)
  • Source/include/Ably/ARTRealtimeChannel.h (1 hunks)
💤 Files with no reviewable changes (1)
  • Source/PrivateHeaders/Ably/ARTRealtimeChannel+Private.h
🚧 Files skipped from review as they are similar to previous changes (1)
  • Source/include/Ably/ARTRealtimeChannel.h

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

…chSerial` and `channelSerial` to be set and tested in other SDKs e.g. chat-swift
@umair-ably umair-ably merged commit 4856ba6 into main Oct 14, 2024
6 of 8 checks passed
@umair-ably umair-ably deleted the publicChannelPropertiesInit branch October 14, 2024 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants