Login & Logout

Last updated: 2020-05-14 18:28:53

    TIMLogin

    This API is used to log in to the Tencent backend server.

    Prototype

    TIM_DECL int TIMLogin(const char* user_id, const char* user_sig, TIMCommCallback cb, const void* user_data);

    Parameters

    Parameter Type Description
    user_id const char* UserID of a user.
    user_sig const char* UserSig of a user.
    cb TIMCommCallback Callback function for notifying whether login was successful. For more information about the callback function definition, see TIMCommCallback.
    user_data const void* User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data.

    Return values

    Type Description
    int If TIM_SUCC is returned, the API was successfully called. (The callback cb is called only when the API returns TIM_SUCC.) If other values are returned, the API failed to be called. For more information about the definition of each return value, see TIMResult.

    Users can send and receive messages only after they have logged in to the Tencent backend server. To log in to the Tencent backend server, a user needs to provide information, including the UserID and UserSig. For more information about these parameters, see Login Authentication.

    TIMLogout

    This API is used to log out of the Tencent backend server.

    Prototype

    TIM_DECL int TIMLogout(TIMCommCallback cb, const void* user_data);

    Parameters

    Parameter Type Description
    cb TIMCommCallback Callback function for indicating whether logout was successful. For more information about the callback function definition, see TIMCommCallback.
    user_data const void* User-defined data. The IM SDK only transfers the user data to the callback function cb without processing the data.

    Return values

    Type Description
    int If TIM_SUCC is returned, the API was successfully called. (The callback cb is called only when the API returns TIM_SUCC.) If other values are returned, the API failed to be called. For more information about the definition of each return value, see TIMResult.

    Call this API if you need to log out of the server or switch to another user.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help