Version: 5.5

Disconnect reasons

For both 1-to-1 calls and group calls, LINE Planet provides a reason for call disconnection, which is called a disconnect reason. The disconnect reason values are commonly defined for client and server.

When a call is disconnected, a disconnect reason is delivered with a disconnect source, so you can use the information to determine the cause and source of call disconnection.

Note

The SDK versions that support disconnect reason values commonly defined for the client and server are as follows:

Android, iOS/macOS, Windows: PlanetKit 5.1 or higher
Web: WebPlanetKit 5.2 or higher

You can get the information from PlanetKitDisconnectedParam delivered by the didDisconnect callback for 1-to-1 calls or group calls.

// For 1-to-1 calls
func didDisconnect(_ call: PlanetKitCall, disconnected: PlanetKitDisconnectedParam)

// For group calls
func didDisconnect(_ conference: PlanetKitConference, disconnected: PlanetKitDisconnectedParam)

The PlanetKitDisconnectedParam class consists of the following properties.

public class PlanetKitDisconnectedParam: NSObject {
    // Disconnect reason
    @objc public let reason: PlanetKitDisconnectReason
    // Disconnect source
    @objc public let source: PlanetKitDisconnectSource
    // Whether the disconnection was made by a remote user or not
    @objc public let byRemote: Bool
    // User-defined release code
    @objc public let userCode: String?
}

Disconnect sources

The following types of disconnect sources are available in the PlanetKitDisconnectSource enumeration.

Enumeration case	Value	Description
`callee`	1	A callee in a 1-to-1 call
`caller`	2	A caller in a 1-to-1 call
`participant`	3	A participant in a group call
`cloudServer`	4	LINE Planet Cloud server
`appServer`	5	Application server