Package io.rong.push.notification

## Class PushNotificationMessage

- All Implemented Interfaces:

      public class PushNotificationMessage

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class | Description
    --- | --- | ---
    `public enum` | `PushNotificationMessage.PushSourceType` |

  - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `public String` | `pushId` |
    `public RongPushClient.ConversationType` | `conversationType` |
    `public long` | `receivedTime` |
    `public String` | `objectName` |
    `public String` | `senderId` |
    `public String` | `senderName` |
    `public Uri` | `senderPortrait` |
    `public String` | `targetId` |
    `public String` | `targetUserName` |
    `public String` | `toId` |
    `public String` | `pushTitle` |
    `public String` | `pushContent` |
    `public String` | `pushData` |
    `public String` | `extra` |
    `public PushNotificationMessage.PushSourceType` | `sourceType` |
    `public String` | `intent` |
    `public int` | `voip` |
    `public String` | `notificationId` |
    `public boolean` | `isShowDetail` |
    `public String` | `channelIdMi` |
    `public String` | `channelIdHW` |
    `public String` | `channelIdOPPO` |
    `public String` | `channelIdFCM` |
    `public String` | `collapseKeyFCM` |
    `public String` | `imageUrlFCM` |
    `public String` | `imageUrlHW` |
    `public String` | `imageUrlMi` |
    `public String` | `busChannel` |
    `public String` | `pid` |
    `public final static Creator<PushNotificationMessage>` | `CREATOR` |

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `PushNotificationMessage()` |

  - ### Enum Constant Summary

    Enum Constants
    Enum Constant | Description
    --- | ---

  - ### Method Summary

    Modifier and Type | Method | Description
    --- | --- | ---
    `String` | `getPushId()` | 获取标识该推送消息的唯一Id.
    `void` | `setPushId(String id)` |
    `RongPushClient.ConversationType` | `getConversationType()` | 获取该推送消息所属的会话类型。比如单聊，群组，讨论组等。
    `void` | `setConversationType(RongPushClient.ConversationType type)` |
    `long` | `getReceivedTime()` | 获取该推送消息的到达时间.
    `void` | `setReceivedTime(long time)` |
    `String` | `getObjectName()` | 获取该推送消息的类型.
    `void` | `setObjectName(String objectName)` |
    `String` | `getSenderId()` | 获取该推送消息的发送者Id。
    `void` | `setSenderId(String id)` |
    `String` | `getSenderName()` | 获取该推送消息的发送者名称。
    `void` | `setSenderName(String name)` |
    `Uri` | `getSenderPortrait()` | 获取该推送消息的发送者头像。
    `void` | `setSenderPortrait(Uri uri)` |
    `String` | `getTargetId()` | 获取该推送消息的目标Id.
    `void` | `setTargetId(String id)` |
    `String` | `getTargetUserName()` | 获取该推送消息的目标名称.
    `void` | `setTargetUserName(String name)` |
    `String` | `getToId()` | 获取推送的目标用户 id.
    `void` | `setToId(String id)` |
    `String` | `getPushTitle()` | 推送标题。目前此字段没有启用。
    `void` | `setPushTitle(String title)` |
    `String` | `getPushContent()` | 获取推送通知的显示内容。 当该推送消息是自定义消息时，此处的值对应 sendMessage() 的参数 pushContent 的内容。如果您在发送自定义消息时， 没有填写 pushContent， 则收不到推送。
    `void` | `setPushContent(String content)` |
    `String` | `getPushData()` | 获取推送消息携带的附加信息。此处的值对应 sendMessage() 的参数 pushData 的内容。 使用场景：发送自定义消息时，如果在sendMessage()时填写参数pushData, 则收到这条消息的推送时，可以通过该方法获取 pushData 的内容。
    `void` | `setPushData(String appDataContent)` |
    `String` | `getExtra()` | 获取从开发者后台使用推送服务时，自定义的附加信息键值对。 该字段仅为开发者后台的推送服务使用，其余情况为null。
    `void` | `setExtra(String extra)` |
    `PushNotificationMessage.PushSourceType` | `getSourceType()` | 获取该推送的来源。PushSourceType
    `void` | `setSourceType(PushNotificationMessage.PushSourceType type)` |
    `String` | `getIntent()` | 针对于华为和 FCM 的跳转意图
    `void` | `setIntent(String intent)` |
    `int` | `getVoip()` |
    `void` | `setVoip(int isVoip)` |
    `String` | `getNotificationId()` |
    `void` | `setNotificationId(String notificationId)` |
    `boolean` | `isShowDetail()` |
    `void` | `setShowDetail(boolean showDetail)` |
    `String` | `getChannelIdMi()` |
    `void` | `setChannelIdMi(String channelIdMi)` |
    `String` | `getChannelIdHW()` |
    `void` | `setChannelIdHW(String channelIdHW)` |
    `String` | `getChannelIdOPPO()` |
    `void` | `setChannelIdOPPO(String channelIdOPPO)` |
    `String` | `getChannelIdFCM()` |
    `void` | `setChannelIdFCM(String channelIdFCM)` |
    `String` | `getCollapseKeyFCM()` |
    `void` | `setCollapseKeyFCM(String collapseKeyFCM)` |
    `String` | `getImageUrlFCM()` |
    `void` | `setImageUrlFCM(String imageUrlFCM)` |
    `String` | `getImageUrlHW()` |
    `void` | `setImageUrlHW(String imageUrlHW)` |
    `String` | `getImageUrlMi()` |
    `void` | `setImageUrlMi(String imageUrlMi)` |
    `String` | `getBusChannel()` |
    `void` | `setBusChannel(String busChannel)` |
    `String` | `getPid()` |
    `void` | `setPid(String pid)` |
    `void` | `setPushFlag(String value)` |
    `String` | `getPushFlag()` | 标识该消息是推送消息还是后台消息。
    `boolean` | `isDisablePushTitle()` |
    `int` | `describeContents()` |
    `void` | `writeToParcel(Parcel dest, int flags)` |
    `String` | `toString()` |
    `void` | `setDisablePushTitle(boolean disablePushTitle)` |

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### PushNotificationMessage

          PushNotificationMessage()

  - ### Method Detail

    - #### getPushId

           String getPushId()

      获取标识该推送消息的唯一Id. 当使用开发者后台的广播推送服务时，该Id用来追踪推送打开率。如果您自定义了推送通知的展示，在点击通知时需要调用 recordNotificationEvent 来上传推送打开事件，以便融云后台正确的帮您统计推送打开率。

      Returns:

        当使用开发者后台的广播推送服务时, 返回符串为pushId,如果是消息转push时，则代表的是消息的uid。

    - #### setPushId

           void setPushId(String id)

    - #### getConversationType

           RongPushClient.ConversationType getConversationType()

      获取该推送消息所属的会话类型。比如单聊，群组，讨论组等。

    - #### setConversationType

           void setConversationType(RongPushClient.ConversationType type)

    - #### getReceivedTime

           long getReceivedTime()

      获取该推送消息的到达时间. 该时间是此条消息到达融云服务器的时间。

    - #### setReceivedTime

           void setReceivedTime(long time)

    - #### getObjectName

           String getObjectName()

      获取该推送消息的类型. 比如文本消息为“RC:TxtMsg”，图片消息为“RC:ImgMsg”，语音消息为“RC:VcMsg”，或者如果是自定义消息， 则此处对应自定义消息的注解MessageTag里value的值。

    - #### setObjectName

           void setObjectName(String objectName)

    - #### getSenderId

           String getSenderId()

      获取该推送消息的发送者Id。

    - #### setSenderId

           void setSenderId(String id)

    - #### getSenderName

           String getSenderName()

      获取该推送消息的发送者名称。

    - #### setSenderName

           void setSenderName(String name)

    - #### getSenderPortrait

           Uri getSenderPortrait()

      获取该推送消息的发送者头像。

    - #### setSenderPortrait

           void setSenderPortrait(Uri uri)

    - #### getTargetId

           String getTargetId()

      获取该推送消息的目标Id. 如该推送发给 A 用户的 123 群组, 则这里返回群 123 的 id.

      Returns:

        该推送消息的目标Id. 比如单聊时，是对方的id; 群组时，是群id.

    - #### setTargetId

           void setTargetId(String id)

    - #### getTargetUserName

           String getTargetUserName()

      获取该推送消息的目标名称. 如该推送发给 A 用户的 123 群组, 则这里返回群 123 的名称.

      Returns:

        该推送消息的目标名称. 比如单聊时，是对方的名称; 群组时，是群名称.

    - #### setTargetUserName

           void setTargetUserName(String name)

    - #### getToId

           String getToId()

      获取推送的目标用户 id. 如这条推送发给 A 用户的 123 群组, 则这里返回用户 A 的 id.

      Returns:

        获取推送的目标用户 id.

    - #### setToId

           void setToId(String id)

    - #### getPushTitle

           String getPushTitle()

      推送标题。目前此字段没有启用。

    - #### setPushTitle

           void setPushTitle(String title)

    - #### getPushContent

           String getPushContent()

      获取推送通知的显示内容。 当该推送消息是自定义消息时，此处的值对应 sendMessage() 的参数 pushContent 的内容。如果您在发送自定义消息时， 没有填写 pushContent， 则收不到推送。

    - #### setPushContent

           void setPushContent(String content)

    - #### getPushData

           String getPushData()

      获取推送消息携带的附加信息。此处的值对应 sendMessage() 的参数 pushData 的内容。 使用场景：发送自定义消息时，如果在sendMessage()时填写参数pushData, 则收到这条消息的推送时，可以通过该方法获取 pushData 的内容。

    - #### setPushData

           void setPushData(String appDataContent)

    - #### getExtra

           String getExtra()

      获取从开发者后台使用推送服务时，自定义的附加信息键值对。 该字段仅为开发者后台的推送服务使用，其余情况为null。

    - #### setExtra

           void setExtra(String extra)

    - #### getSourceType

           PushNotificationMessage.PushSourceType getSourceType()

      获取该推送的来源。PushSourceType

      Returns:

        推送来源。

    - #### setSourceType

           void setSourceType(PushNotificationMessage.PushSourceType type)

    - #### getIntent

           String getIntent()

      针对于华为和 FCM 的跳转意图

    - #### setIntent

           void setIntent(String intent)

    - #### getVoip

           int getVoip()

    - #### setVoip

           void setVoip(int isVoip)

    - #### getNotificationId

           String getNotificationId()

    - #### setNotificationId

           void setNotificationId(String notificationId)

    - #### isShowDetail

           boolean isShowDetail()

    - #### setShowDetail

           void setShowDetail(boolean showDetail)

    - #### getChannelIdMi

           String getChannelIdMi()

    - #### setChannelIdMi

           void setChannelIdMi(String channelIdMi)

    - #### getChannelIdHW

           String getChannelIdHW()

    - #### setChannelIdHW

           void setChannelIdHW(String channelIdHW)

    - #### getChannelIdOPPO

           String getChannelIdOPPO()

    - #### setChannelIdOPPO

           void setChannelIdOPPO(String channelIdOPPO)

    - #### getChannelIdFCM

           String getChannelIdFCM()

    - #### setChannelIdFCM

           void setChannelIdFCM(String channelIdFCM)

    - #### getCollapseKeyFCM

           String getCollapseKeyFCM()

    - #### setCollapseKeyFCM

           void setCollapseKeyFCM(String collapseKeyFCM)

    - #### getImageUrlFCM

           String getImageUrlFCM()

    - #### setImageUrlFCM

           void setImageUrlFCM(String imageUrlFCM)

    - #### getImageUrlHW

           String getImageUrlHW()

    - #### setImageUrlHW

           void setImageUrlHW(String imageUrlHW)

    - #### getImageUrlMi

           String getImageUrlMi()

    - #### setImageUrlMi

           void setImageUrlMi(String imageUrlMi)

    - #### getBusChannel

           String getBusChannel()

    - #### setBusChannel

           void setBusChannel(String busChannel)

    - #### getPid

           String getPid()

    - #### setPid

           void setPid(String pid)

    - #### setPushFlag

           void setPushFlag(String value)

    - #### getPushFlag

           String getPushFlag()

      标识该消息是推送消息还是后台消息。

    - #### isDisablePushTitle

           boolean isDisablePushTitle()

    - #### describeContents

           int describeContents()

    - #### writeToParcel

           void writeToParcel(Parcel dest, int flags)

    - #### toString

           String toString()

    - #### setDisablePushTitle

           void setDisablePushTitle(boolean disablePushTitle)