Skip to content

Conversation

@nan-li
Copy link
Contributor

@nan-li nan-li commented Jan 19, 2023

Description

One Line Summary

All public objects that need a serialization method for wrapper SDKs have one, but make the method naming consistent by using jsonRepresentation for all.

Details

Motivation

  • All public objects that need a serialization method for wrapper SDKs have one
  • But some are named toDictionary while the majority are named jsonRepresentation
  • For consistency, name all these to jsonRepresentation

Checked all of these objects:

✅ OSInAppMessage 
✅ OSInAppMessageAction 
✅ OSOutcomeEvent 
✅ OSPushSubscriptionState 
✅ OSPushSubscriptionStateChanges 
✅ OSPermissionState
✅ OSPermissionStateChanges 
✅ OSNotification 
✅ OSNotificationOpenedResult 

I don't think I am missing any other public objects.

Scope

Nit naming.

Testing

Manual testing

Dev app builds and runs.

Affected code checklist

  • Notifications
    • Display
    • Open
    • Push Processing
    • Confirm Deliveries
  • Outcomes
  • Sessions
  • In-App Messaging
  • REST API requests
  • Public API changes

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
  • Any Public API changes are explained in the PR details and conform to existing APIs

Testing

  • I have included test coverage for these changes, or explained why they are not needed
  • All automated tests pass, or I explained why that is not possible
  • I have personally tested this on my device, or explained why that is not possible

Final pass

  • Code is as readable as possible.
  • I have reviewed this PR myself, ensuring it meets each checklist item

This change is Reviewable

* All public objects that need a serialization method for wrapper SDKs have one
* But some are named `toDictionary` while the majority are named `jsonRepresentation`
* For consistency, name all these to `jsonRepresentation`
@nan-li nan-li changed the title [5.0.0] no functional changes - jsonRepresentation method name consistency [5.0.0] no functional changes - jsonRepresentation method name consistency Jan 19, 2023
Base automatically changed from 5.0.0/expose_set_launch_options to major_release_5.0.0 January 23, 2023 20:54
@nan-li nan-li merged commit 78e9f05 into major_release_5.0.0 Jan 23, 2023
@nan-li nan-li deleted the 5.0.0/json_representation_method branch January 23, 2023 20:54
nan-li added a commit that referenced this pull request Oct 30, 2023
[5.0.0] no functional changes - `jsonRepresentation` method name consistency
nan-li added a commit that referenced this pull request Oct 30, 2023
[5.0.0] no functional changes - `jsonRepresentation` method name consistency
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants