added a function to be implemented in the api