Index

B C E G H I N P S T U V 
All Classes and Interfaces|All Packages|Serialized Form

B

build() - Method in class com.checkhim.models.VerificationRequest.Builder
Builds and returns a new VerificationRequest instance.
builder() - Static method in class com.checkhim.models.VerificationRequest
Creates a new builder instance for constructing VerificationRequest objects.
Builder() - Constructor for class com.checkhim.models.VerificationRequest.Builder
 

C

CheckHim - Class in com.checkhim
Main client class for interacting with the CheckHim phone number verification API.
CheckHim(String) - Constructor for class com.checkhim.CheckHim
Creates a new CheckHim client with the specified API key.
CheckHim(String, String) - Constructor for class com.checkhim.CheckHim
Creates a new CheckHim client with the specified API key and custom base URL.
CheckHimException - Exception in com.checkhim.exceptions
Base exception class for all CheckHim SDK related errors.
CheckHimException(String) - Constructor for exception com.checkhim.exceptions.CheckHimException
Creates a new CheckHimException with the specified message.
CheckHimException(String, String, int) - Constructor for exception com.checkhim.exceptions.CheckHimException
Creates a new CheckHimException with detailed error information.
CheckHimException(String, String, int, Throwable) - Constructor for exception com.checkhim.exceptions.CheckHimException
Creates a new CheckHimException with detailed error information and cause.
CheckHimException(String, Throwable) - Constructor for exception com.checkhim.exceptions.CheckHimException
Creates a new CheckHimException with the specified message and cause.
close() - Method in class com.checkhim.CheckHim
Closes the HTTP client and releases any resources.
close() - Method in class com.checkhim.http.HttpClient
Closes the HTTP client and releases resources.
com.checkhim - package com.checkhim
 
com.checkhim.exceptions - package com.checkhim.exceptions
 
com.checkhim.http - package com.checkhim.http
 
com.checkhim.models - package com.checkhim.models
 

E

equals(Object) - Method in class com.checkhim.models.VerificationRequest
 
equals(Object) - Method in class com.checkhim.models.VerificationResponse
 
ErrorResponse - Class in com.checkhim.models
Represents an error response from the CheckHim API.
ErrorResponse() - Constructor for class com.checkhim.models.ErrorResponse
Default constructor for JSON deserialization.

G

getApiKey() - Method in class com.checkhim.CheckHim
Gets the API key being used by this client.
getBaseUrl() - Method in class com.checkhim.CheckHim
Gets the base URL being used by this client.
getCarrier() - Method in class com.checkhim.models.VerificationResponse
Gets the carrier/network provider name.
getCode() - Method in class com.checkhim.models.ErrorResponse
Gets the error code from the API.
getCountry() - Method in class com.checkhim.models.VerificationResponse
Gets the country code (ISO 3166-1 alpha-2).
getCountryCode() - Method in class com.checkhim.models.VerificationResponse
Gets the numeric country code.
getCountryName() - Method in class com.checkhim.models.VerificationResponse
Gets the full country name.
getDisplayMessage() - Method in class com.checkhim.models.ErrorResponse
Gets the most appropriate error message to display.
getError() - Method in class com.checkhim.models.ErrorResponse
Gets the error message from the API.
getErrorCode() - Method in exception com.checkhim.exceptions.CheckHimException
Gets the CheckHim-specific error code.
getHttpStatusCode() - Method in exception com.checkhim.exceptions.CheckHimException
Gets the HTTP status code from the API response.
getLineType() - Method in class com.checkhim.models.VerificationResponse
Gets the line type (mobile, landline, etc.).
getMessage() - Method in class com.checkhim.models.ErrorResponse
Gets an additional error message if available.
getNetworkCode() - Method in class com.checkhim.models.VerificationResponse
Gets the network code.
getNumber() - Method in class com.checkhim.models.VerificationRequest
Gets the phone number to be verified.
getStatus() - Method in class com.checkhim.models.VerificationResponse
Gets the verification status code.
getType() - Method in class com.checkhim.models.VerificationRequest
Gets the request type.
getValid() - Method in class com.checkhim.models.VerificationResponse
Gets the validation status as a Boolean object.

H

hashCode() - Method in class com.checkhim.models.VerificationRequest
 
hashCode() - Method in class com.checkhim.models.VerificationResponse
 
HttpClient - Class in com.checkhim.http
HTTP client wrapper for making requests to the CheckHim API.
HttpClient(String, String) - Constructor for class com.checkhim.http.HttpClient
Creates a new HTTP client with the specified API key and base URL.

I

InvalidFormatException - Exception in com.checkhim.exceptions
Exception thrown when a phone number has an invalid format.
InvalidFormatException(String, int) - Constructor for exception com.checkhim.exceptions.InvalidFormatException
Creates a new InvalidFormatException.
InvalidFormatException(String, int, Throwable) - Constructor for exception com.checkhim.exceptions.InvalidFormatException
Creates a new InvalidFormatException with a cause.
isClientError() - Method in exception com.checkhim.exceptions.CheckHimException
Checks if this exception represents a client error (4xx status code).
isServerError() - Method in exception com.checkhim.exceptions.CheckHimException
Checks if this exception represents a server error (5xx status code).
isValid() - Method in class com.checkhim.models.VerificationResponse
Checks if the phone number is valid.

N

NetworkRejectedException - Exception in com.checkhim.exceptions
Exception thrown when a phone number verification fails due to network issues.
NetworkRejectedException(String, int) - Constructor for exception com.checkhim.exceptions.NetworkRejectedException
Creates a new NetworkRejectedException.
NetworkRejectedException(String, int, Throwable) - Constructor for exception com.checkhim.exceptions.NetworkRejectedException
Creates a new NetworkRejectedException with a cause.
number(String) - Method in class com.checkhim.models.VerificationRequest.Builder
Sets the phone number to be verified.

P

post(String, T, Class<R>) - Method in class com.checkhim.http.HttpClient
Makes a POST request to the specified endpoint.
PrefixMissingException - Exception in com.checkhim.exceptions
Exception thrown when a phone number is missing the required country prefix.
PrefixMissingException(String, int) - Constructor for exception com.checkhim.exceptions.PrefixMissingException
Creates a new PrefixMissingException.
PrefixMissingException(String, int, Throwable) - Constructor for exception com.checkhim.exceptions.PrefixMissingException
Creates a new PrefixMissingException with a cause.

S

setCarrier(String) - Method in class com.checkhim.models.VerificationResponse
Sets the carrier/network provider name.
setCode(String) - Method in class com.checkhim.models.ErrorResponse
Sets the error code.
setCountry(String) - Method in class com.checkhim.models.VerificationResponse
Sets the country code.
setCountryCode(String) - Method in class com.checkhim.models.VerificationResponse
Sets the numeric country code.
setCountryName(String) - Method in class com.checkhim.models.VerificationResponse
Sets the full country name.
setError(String) - Method in class com.checkhim.models.ErrorResponse
Sets the error message.
setLineType(String) - Method in class com.checkhim.models.VerificationResponse
Sets the line type.
setMessage(String) - Method in class com.checkhim.models.ErrorResponse
Sets an additional error message.
setNetworkCode(String) - Method in class com.checkhim.models.VerificationResponse
Sets the network code.
setNumber(String) - Method in class com.checkhim.models.VerificationRequest
Sets the phone number to be verified.
setStatus(String) - Method in class com.checkhim.models.VerificationResponse
Sets the verification status code.
setType(String) - Method in class com.checkhim.models.VerificationRequest
Sets the request type.
setValid(Boolean) - Method in class com.checkhim.models.VerificationResponse
Sets the validation status.
SubscriberAbsentException - Exception in com.checkhim.exceptions
Exception thrown when the subscriber is temporarily absent or unreachable.
SubscriberAbsentException(String, int) - Constructor for exception com.checkhim.exceptions.SubscriberAbsentException
Creates a new SubscriberAbsentException.
SubscriberAbsentException(String, int, Throwable) - Constructor for exception com.checkhim.exceptions.SubscriberAbsentException
Creates a new SubscriberAbsentException with a cause.

T

toString() - Method in exception com.checkhim.exceptions.CheckHimException
 
toString() - Method in class com.checkhim.models.ErrorResponse
 
toString() - Method in class com.checkhim.models.VerificationRequest
 
toString() - Method in class com.checkhim.models.VerificationResponse
 
type(String) - Method in class com.checkhim.models.VerificationRequest.Builder
Sets the request type (internal use only).

U

UnknownSubscriberException - Exception in com.checkhim.exceptions
Exception thrown when the subscriber is unknown to the network.
UnknownSubscriberException(String, int) - Constructor for exception com.checkhim.exceptions.UnknownSubscriberException
Creates a new UnknownSubscriberException.
UnknownSubscriberException(String, int, Throwable) - Constructor for exception com.checkhim.exceptions.UnknownSubscriberException
Creates a new UnknownSubscriberException with a cause.

V

VerificationRequest - Class in com.checkhim.models
Represents a phone number verification request to the CheckHim API.
VerificationRequest() - Constructor for class com.checkhim.models.VerificationRequest
Default constructor for JSON serialization.
VerificationRequest.Builder - Class in com.checkhim.models
Builder class for constructing VerificationRequest instances with a fluent API.
VerificationResponse - Class in com.checkhim.models
Represents the response from a phone number verification request.
VerificationResponse() - Constructor for class com.checkhim.models.VerificationResponse
Default constructor for JSON deserialization.
verify(VerificationRequest) - Method in class com.checkhim.CheckHim
Verifies a phone number using the CheckHim API.
verify(String) - Method in class com.checkhim.CheckHim
Convenience method to verify a phone number using just the number string.
B C E G H I N P S T U V 
All Classes and Interfaces|All Packages|Serialized Form