Close Menu

rmessage

Introduction

Welcome to the documentation page for RMessage, a powerful messaging framework developed for iOS applications. Whether you are looking to implement in-app messaging, push notifications, or in-app notifications, RMessage has got you covered. This guide will walk you through the installation process, basic usage, and advanced features of RMessage.

Table of Contents

  1. Requirements
  2. Installation
  3. Usage
  4. Customization
  5. Advanced Features

Requirements

Before getting started with RMessage, please ensure that your iOS project meets the following requirements:

  • iOS 9.0 or later
  • Xcode 10.0 or later
  • Swift 4.2 or later

Installation

To integrate RMessage into your iOS project, follow the steps below:

  1. Install RMessage via CocoaPods by adding the following line to your Podfile:
    pod 'RMessage'
  2. Run the command pod install in your project directory
  3. Open your Xcode project and navigate to the folder containing your .xcworkspace file. Then, reopen your project using the .xcworkspace file
  4. You’re all set! You can now import RMessage into your Swift files and start using it in your project

Usage

To display a message using RMessage, you simply need to call the showNotification method with your desired parameters. Here’s a basic example:


import RMessage

// ...Your code...

RMessage.showNotification(title: "Hello World!", subtitle: "Welcome to RMessage!", iconImage: UIImage(named: "notificationIcon"))

// ...Your code...

Customization

Themes

RMessage provides various built-in themes to customize the appearance of your messages. To select a theme, call the setDefaultViewController method and specify your desired theme. Here’s an example:


RMessage.setDefaultViewController(theme: .success)

// ...Your code...

Animations

RMessage also allows you to customize the animations for message presentation and dismissal. You can choose from pre-defined animations or even create your own animation methods. Check out the code snippet below for changing the animation type:


RMessage.manager().customise(animations: [.slide(.top), .fade])

// ...Your code...

Positioning

You can control the positioning of messages using various pre-defined positions (e.g. top, bottom, center). To change the position, use the following code:


RMessage.setDefaultViewController(position: .bottom)

// ...Your code...

Advanced Features

Message Queue

RMessage provides the ability to queue messages during high-frequency notifications. This ensures that messages are displayed without overlap. To enable the message queue, use the following code:


RMessage.manager().enableQueue(true)

// ...Your code...

Interaction Events

RMessage allows you to handle user interactions with messages by implementing specific delegate methods. Here’s how you can use the delegate method to handle tap events:


class YourViewController: UIViewController, RMessageProtocol {
  override func viewDidLoad() {
    super.viewDidLoad()
    
    // ...Your code...
    
    RMessage.setDefaultViewController(delegate: self)
    
    // ...Your code...
  }
  
  // ...Your code...
  
  func messageClicked(_ message: RMessage) {
    // Handle tap event
  }
  
  // ...Your code...
}

// ...Your code...

Conclusion

Congratulations! You’ve successfully learned how to integrate and utilize RMessage for your iOS project. With its powerful messaging capabilities and customizable features, you can provide a seamless and engaging experience for your app users. For more detailed information, please refer to the official RMessage GitHub repository. Happy coding!